- nlcpy.mod = <ufunc 'nlcpy_remainder'>
Computes the element-wise remainder of division.
Computes the remainder complementary to the
floor_divide()function. It is equivalent to the Python modulus operator
x1 % x2and has the same sign as the divisor x2.
- x1, x2array_like
x1 is a dividend array and x2 is a divisor array. If
x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).
- outndarray or None, optional
A location into which the result is stored. If provided, it must have a shape that the inputs broadcast to. If not provided or None, a freshly-allocated array is returned. A tuple (possible only as a keyword argument) must have length equal to the number of outputs.
- wherearray_like, optional
This condition is broadcast over the input. At locations where the condition is True, the out array will be set to the ufunc result. Elsewhere, the out array will retain its original value. Note that if an uninitialized out array is created via the default
out=None, locations within it where the condition is False will remain uninitialized.
For other keyword-only arguments, see the section Optional Keyword Arguments.
The element-wise remainder of the quotient
floor_divide(x1,x2). If x1 and x2 are both scalars, this function returns the result as a 0-dimension ndarray.
Returns 0 when x2 is 0 and both x1 and x2 are integers.
mod : an alias of this function.
>>> import nlcpy as vp >>> vp.remainder([4, 7], [2, 3]) array([0, 1]) >>> vp.remainder(vp.arange(7), 5) array([0, 1, 2, 3, 4, 0, 1])