:mod:`chunkblocks.iterators`
============================

.. py:module:: chunkblocks.iterators







Module Contents
---------------






.. data:: all_neighbor_offsets
   

   









.. py:class:: Iterator

   Bases::class:`object`

   

   

   .. method:: get_all_neighbors(self, index, max=None)

      



   

   .. method:: iterator(self, index)

      











.. py:class:: UnitIterator

   Bases::class:`chunkblocks.iterators.Iterator`

   

   

   

   .. method:: get_all_neighbors(self, index, max=None)

      
      Return all neighbors including diagonals

      











.. py:class:: UnitBFSIterator

   Bases::class:`chunkblocks.iterators.UnitIterator`

   

   

   .. method:: get(self, start, dimensions)

      
      Get an iterator that traverses dataset in single units using Breadth-First-Search fashion.
      Units start at 0 and end at param: dimensions
      :param start: location to start iteration from
      :param dimensions: list or tuple of units for each dimension