jax.numpy.ravel_multi_index

jax.numpy.ravel_multi_index(multi_index, dims, mode='raise', order='C')[source]
Converts a tuple of index arrays into an array of flat

indices, applying boundary modes to the multi-index.

LAX-backend implementation of ravel_multi_index(). Original docstring below.

ravel_multi_index(multi_index, dims, mode=’raise’, order=’C’)

Returns
raveled_indicesndarray

An array of indices into the flattened version of an array of dimensions dims.

unravel_index

New in version 1.6.0.

>>> arr = np.array([[3,6,6],[4,5,1]])
>>> np.ravel_multi_index(arr, (7,6))
array([22, 41, 37])
>>> np.ravel_multi_index(arr, (7,6), order='F')
array([31, 41, 13])
>>> np.ravel_multi_index(arr, (4,6), mode='clip')
array([22, 23, 19])
>>> np.ravel_multi_index(arr, (4,4), mode=('clip','wrap'))
array([12, 13, 13])
>>> np.ravel_multi_index((3,1,4,1), (6,7,8,9))
1621