numpy.ravel_multi_index#
- numpy.ravel_multi_index(multi_index, dims, mode='raise', order='C')#
将索引数组的元组转换为扁平索引的数组,对多索引应用边界模式。
- 参数:
- multi_indexarray_like 的元组
整数数组的元组,每个维度一个数组。
- dims整数的元组
来自
multi_index
的索引应用到的数组的形状。- mode{‘raise’, ‘wrap’, ‘clip’},可选
指定如何处理越界索引。可以指定一个模式或一个模式元组,每个索引一个模式。
‘raise’ – 抛出错误(默认)
‘wrap’ – 环绕
‘clip’ – 裁剪到范围内
在“clip”模式下,通常会环绕的负索引将改为裁剪到 0。
- order{‘C’, ‘F’},可选
确定是否应将多索引视为按行主序(C 样式)或列主序(Fortran 样式)排序进行索引。
- 返回值:
- raveled_indicesndarray
指向维度为
dims
的数组的扁平版本的索引数组。
备注
版本 1.6.0 中的新功能。
示例
>>> 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