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
-
- 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
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)
Methods
ndincr
()Increment the multi-dimensional index by one.
© 2005–2021 NumPy Developers
Licensed under the 3-clause BSD License.
https://numpy.org/doc/1.21/reference/generated/numpy.ndindex.html