numpy.lib.array_utils.normalize_axis_tuple#

lib.array_utils.normalize_axis_tuple(axis, ndim, argname=None, allow_duplicate=False)[source]#

将轴参数规范化为非负整数轴的元组。

这处理诸如 1 之类的简写形式并将其转换为 (1,),以及执行 normalize_axis_index 所涵盖的负索引处理。

默认情况下,这禁止轴被指定多次。

在多轴检查逻辑中内部使用。

1.13.0 版中的新内容。

参数:
axisint, int 可迭代对象

轴的未规范化索引或索引。

ndimint

数组的维数,axis 应该针对它进行规范化。

argnamestr, 可选

要在错误消息之前添加的前缀,通常是参数的名称。

allow_duplicatebool, 可选

如果为 False(默认值),则禁止轴被指定两次。

返回值:
normalized_axesint 元组

规范化的轴索引,使得 0 <= normalized_axis < ndim

引发:
AxisError

如果提供的任何轴超出范围

ValueError

如果轴重复

参见

normalize_axis_index

规范化单个标量轴