Previous topic

numpy.nditer.reset

Next topic

numpy.ndindex.ndincr

This is documentation for an old release of NumPy (version 1.15). Read this page in the documentation of the latest stable release (version 2.2).

numpy.ndindex

class numpy.ndindex(*shape)[source]

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:
`*args` : ints

The size of each dimension of the array.

See also

ndenumerate, flatiter

Examples

>>>
>>> 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)

Methods

ndincr() Increment the multi-dimensional index by one.
next() Standard iterator method, updates the index and returns the index tuple.