numpy.mod

numpy.mod(x1, x2, /, out=None, *, where=True, casting='same_kind', order='K', dtype=None, subok=True[, signature, extobj]) = <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, или кортеж ndarray и None, необязательно

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

wherearray_like, необязательно

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

**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])