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 math.remainder и C, которая вычисляет остаток 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

Это условие транслируется по входным данным. В местах, где условие истинно, массив 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])