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

Параметры:

x1 : array_like Массив делимого. x2 : array_like Массив делителя. out : ndarray, None, or tuple of ndarray and None, optional Расположение, в которое сохраняется результат. Если предоставлено, оно должно иметь форму, к которой входные данные передаются по принципу векторизации. Если не предоставлено или None, возвращается только что выделенный массив. Кортеж (возможен только как ключевой аргумент) должен иметь длину, равную количеству выходов. where : array_like, optional Значения True указывают на вычисление ufunc в этом положении, значения False указывают на то, что значение в выходе остается неизменным. **kwargs Для других ключевых аргументов см. документацию по ufunc.

Возвращает:

y : ndarray Элемент-wise остаток от частного floor_divide(x1, x2). Это скаляр, если x1 и x2 являются скалярами.

См. также

floor_divide

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

divmod

Одновременное вычисление целой части от деления и остатка.

fmod

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

divide, floor

Примечания

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

Примеры

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