Python numpy ravel_multi_index用法及代码示例

本文简要介绍 python 语言中 numpy.ravel_multi_index 的用法。

用法:

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

将索引数组元组转换为平面索引数组，将边界模式应用于多索引。

参数：

multi_index： 数组 的元组

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

dims： 整数元组

multi_index 中的索引应用到的数组的形状。

mode： {‘raise’, ‘wrap’, ‘clip’}，可选

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

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

• ‘wrap’ - 环绕

• ‘clip’ - 剪辑到范围

在‘clip’ 模式下，通常会换行的负索引将改为剪辑为 0。

order： {‘C’, ‘F’}，可选

确定多重索引是否应被视为按行优先(C 风格)或列优先(Fortran-style)顺序进行索引。

返回：

raveled_indices： ndarray

维度数组的扁平版本的索引数组 dims 。

注意：

例子：

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