jax.numpy.remainder#
- jax.numpy.remainder(x1, x2, /)[source]#
Returns element-wise remainder of the division.
JAX implementation of
numpy.remainder
.- Parameters:
x1 (ArrayLike) – scalar or array. Specifies the dividend.
x2 (ArrayLike) – scalar or array. Specifies the divisor.
x1
andx2
should either have same shape or be broadcast compatible.
- Returns:
An array containing the remainder of element-wise division of
x1
byx2
with same sign as the elements ofx2
.- Return type:
Note
The result of
jnp.remainder
is equivalent tox1 - x2 * jnp.floor(x1 / x2)
.See also
jax.numpy.mod()
: Returns the element-wise remainder of the division.jax.numpy.fmod()
: Calculates the element-wise floating-point modulo operation.jax.numpy.divmod()
: Calculates the integer quotient and remainder ofx1
byx2
, element-wise.
Examples
>>> x1 = jnp.array([[3, -1, 4], ... [8, 5, -2]]) >>> x2 = jnp.array([2, 3, -5]) >>> jnp.remainder(x1, x2) Array([[ 1, 2, -1], [ 0, 2, -2]], dtype=int32) >>> x1 - x2 * jnp.floor(x1 / x2) Array([[ 1., 2., -1.], [ 0., 2., -2.]], dtype=float32)