numpy.lib.index_tricks.ndindex

class documentation

class ndindex:

View In Hierarchy

An N-dimensional iterator object to index arrays.

Given the shape of an array, an ndindex instance iterates over the N-dimensional index of the array. At each iteration a tuple of indices is returned, the last dimension is iterated over first.

Parameters

shape : ints, or a single tuple of ints
The size of each dimension of the array can be passed as individual parameters or as the elements of a tuple.

See Also

ndenumerate, flatiter

Examples

Dimensions as individual arguments

>>> for index in np.ndindex(3, 2, 1):
...     print(index)
(0, 0, 0)
(0, 1, 0)
(1, 0, 0)
(1, 1, 0)
(2, 0, 0)
(2, 1, 0)

Same dimensions - but in a tuple (3, 2, 1)

>>> for index in np.ndindex((3, 2, 1)):
...     print(index)
(0, 0, 0)
(0, 1, 0)
(1, 0, 0)
(1, 1, 0)
(2, 0, 0)
(2, 1, 0)
Method __init__ Undocumented
Method __iter__ Undocumented
Method __next__ Standard iterator method, updates the index and returns the index tuple.
Method ndincr Increment the multi-dimensional index by one.
Instance Variable ​_it Undocumented
def __init__(self, *shape):

Undocumented

def __iter__(self):

Undocumented

def __next__(self):

Standard iterator method, updates the index and returns the index tuple.

Returns

val : tuple of ints
Returns a tuple containing the indices of the current iteration.
def ndincr(self):

Increment the multi-dimensional index by one.

This method is for backward compatibility only: do not use.

Deprecated since version 1.20.0: This method has been advised against since numpy 1.8.0, but only started emitting DeprecationWarning as of this version.
_it =

Undocumented