numpy.mod

numpy.mod(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature])=<ufunc 'remainder'>

Возвращает элементное остаток от деления.

Вычисляет остаток, дополнительный к функции floor_divide. Он эквивалентен оператору Python x1 % x2, и имеет тот же знак, что и делитель x2. Функция MATLAB, эквивалентная np.remainder - это mod.

Предупреждение

Это не следует путать с:

• Python 3.7’s math.remainder и C’s remainder, которые вычисляют остаток IEEE, который является дополнением к round(x1 / x2).
• Функцией MATLAB rem и/или оператором C %, который является дополнением к int(x1 / x2).

Параметры:

x1array_like

Массив делимого.

x2array_like

Массив делителя. Если x1.shape != x2.shape, они должны быть совместимы для трансляции к общему размеру (который становится размером результата).

outndarray, None, or tuple of ndarray and None, optional

Расположение, в которое сохраняется результат. Если указано, оно должно иметь размер, к которому транслируются входные данные. Если не указано или None, возвращается свежевыделенный массив. Кортеж (возможен только как ключевое слово) должен иметь длину, равную количеству выходов.

wherearray_like, optional

Это условие транслируется по входным данным. В местах, где условие True, массив out будет задан результатом ufunc. В противном случае массив out сохранит свое исходное значение. Обратите внимание, что если массив out создан с помощью значения по умолчанию out=None, места в нем, где условие False, останутся неинициализированными.

**kwargs

Для других аргументов только с ключевыми словами см. документацию ufunc.

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

yndarray

Элементный остаток от деления floor_divide(x1, x2). Это скаляр, если x1 и x2 являются скалярами.

См. также

floor_divide

Эквивалент оператора Python //.

divmod

Одновременное получение результата целочисленного деления и остатка.

fmod

Эквивалент функции MATLAB rem.

divide, floor

Примечания

Возвращает 0, когда x2 равно 0, и x1 и x2 являются (массивами) целых чисел. mod является псевдонимом remainder.

Примеры

>>> np.remainder([4, 7], [2, 3])
array([0, 1])
>>> np.remainder(np.arange(7), 5)
array([0, 1, 2, 3, 4, 0, 1])

Оператор % может использоваться как сокращение для np.remainder на ndarrays.

>>> x1 = np.arange(7)
>>> x1 % 5
array([0, 1, 2, 3, 4, 0, 1])