numpy.lib.array_utils.normalize_axis_index

lib.array_utils.normalize_axis_index(axis, ndim, msg_prefix=None)

Нормализует индекс оси, axis, таким образом, чтобы он был допустимым положительным индексом в форме массива с ndim измерениями. Вызывает исключение AxisError с соответствующим сообщением, если это невозможно.

Используется во всех логических операциях проверки осей.

Добавлена в версии 1.13.0.

Параметры:

axisint

Ненормализованный индекс оси. Может быть отрицательным

ndimint

Количество измерений массива, по отношению к которому axis должен быть нормализован

msg_prefixstr

Префикс для добавления к сообщению, обычно имя аргумента

Возвращаемое значение:

normalized_axisint

Нормализованный индекс оси, такой что 0 <= normalized_axis < ndim

Исключения:

AxisError

Если индекс оси недопустим, когда -ndim <= axis < ndim ложно.

Примеры

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