numpy.lib.array_utils.normalize_axis_tuple

lib.array_utils.normalize_axis_tuple(axis, ndim, argname=None, allow_duplicate=False)

将轴参数规范化为由非负整数轴组成的元组.

这处理诸如 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

归一化单个标量轴