numpy.lib.array_utils.normalize_axis_index#
- lib.array_utils.normalize_axis_index(axis, ndim, msg_prefix=None)#
规范化轴索引 axis，使其成为具有
ndim维度的数组形状的有效正索引。如果不可能，则引发具有适当消息的 AxisError。由所有轴检查逻辑内部使用。
- 参数:
- axisint
轴的未规范化索引。可以是负数
- ndimint
应针对其规范化 axis 的数组的维度数
- msg_prefixstr
放在消息之前的字符串，通常是参数的名称
- 返回:
- normalized_axisint
规范化后的轴索引，使 0 <= normalized_axis < ndim
- 引发:
- AxisError
如果轴索引无效，当 -ndim <= axis < ndim 为 false 时。
示例
>>> import numpy as np >>> from numpy.lib.array_utils import normalize_axis_index >>> normalize_axis_index(0, ndim=3) 0 >>> normalize_axis_index(1, ndim=3) 1 >>> normalize_axis_index(-1, ndim=3) 2
>>> normalize_axis_index(3, ndim=3) Traceback (most recent call last): ... numpy.exceptions.AxisError: axis 3 is out of bounds for array ... >>> normalize_axis_index(-4, ndim=3, msg_prefix='axes_arg') Traceback (most recent call last): ... numpy.exceptions.AxisError: axes_arg: axis -4 is out of bounds ...