misc
====

Code for various useful things that don't fit anywhere else.
Currently this includes:

    * Automatically printing the status of long loops
    * Grouping number arrays by id or generating neighbor lists effiently

Example Usage
-------------
.. currentmodule:: ilpm.misc

The :class:`StatusCounter` class can be used either directly as an iterator,
or can be explicitly created and then iterated over.  The latter approach also
allows outputing a variable message during the computation.

.. code-block:: python

    from ilpm import misc
    import numpy as np
    import time
    
    #These are the values over which we are going to compute stuff.
    values = np.linspace(0, 1.0, 10000)
    
    
    #Use the status counter as an iterator -- this automatically prints the
    #  status message as we loop!
    for val in misc.StatusCounter(values, 'Squaring stuff...'):
        square = val**2 #Do something
        time.sleep(1E-3) #This something is too fast, so lets slow it.
    
    
    #Create it as a named object so we can change the print message
    stat = misc.StatusCounter(values, 'Squaring stuff...')
    for val in stat:
        square = val**2 #Do something
        stat.message('%.3f -> %.3f' % (val, square)) #Print the result as we compute.
        time.sleep(1E-3) #This something is too fast, so lets slow it.
        
    
The first loop outputs the following message as it is computing::
    
    Squaring stuff... 49% (0:00:05 remaining)
    

The second includes an ongoing status message, e.g.::

    Squaring stuff... 49% (0:00:05 remaining)  [0.498 -> 0.248]


Overview
--------

.. currentmodule:: ilpm.misc

.. autosummary:: 
    StatusCounter
    GroupById
    NeighborList

Classes
-------
    
.. automodule:: ilpm.misc
    :members: 
    :show-inheritance: