numpy.lib.array_utils.normalize_axis_index#

lib.array_utils.normalize_axis_index(ось, ndim, msg_prefix=None)#

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

Используется внутренне всей логикой проверки осей.

Параметры:

осьint: Ненормализованный индекс оси. Может быть отрицательным
ndimint: Количество измерений массива, которые ось должны быть нормализованы относительно
msg_prefixstr: Префикс, который нужно добавить перед сообщением, обычно имя аргумента

Возвращает:

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

Вызывает:

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

Примеры

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