mod

Contents

mod#

class brainunit.math.mod(x1, x2, **kwargs)#

Return the element-wise modulus of division.

Parameters:

  • x1 (saiunit.Quantity | Array | ndarray | bool | number | bool | int | float | complex) – Input array.

  • x2 (saiunit.Quantity | Array) – Input array.

Returns:

out – Quantity if x1 and x2 are Quantities that have the same unit, else an array.

Return type:

saiunit.Quantity | Array

Examples

>>> import saiunit as u
>>> a = [5, 6, 7] * u.meter
>>> b = [2, 3, 4] * u.meter
>>> u.math.mod(a, b)
Contents