numpy.ravel_multi_index#

numpy.ravel_multi_index(multi_index, dims, mode='raise', order='C')#

将索引数组元组转换为扁平化索引数组,并对多重索引应用边界模式。

参数:
multi_index元组,元素为 array_like

整数数组的元组,每个维度一个数组。

dims整数元组

多重索引 multi_index 中的索引适用的数组的形状。

mode{‘raise’, ‘wrap’, ‘clip’}, optional

指定如何处理越界索引。可以指定一种模式,或一个模式元组,每个索引一种模式。

  • ‘raise’ – 引发错误(默认)

  • ‘wrap’ – 环绕

  • ‘clip’ – 剪辑到范围

在 ‘clip’ 模式下,原本会换行的负数索引将裁剪为 0。

order{‘C’, ‘F’}, optional

确定多重索引是按行主序(C 风格)还是列主序(Fortran 风格)进行索引。

返回:
raveled_indicesndarray

对于具有 dims 维度的数组的扁平化版本,该数组包含索引。

另请参阅

unravel_index

示例

>>> import numpy as np
>>> 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