# xarray.ufuncs.remainder

### xarray.ufuncs.remainder *= <xarray.ufuncs._binary_ufunc object>*

xarray specific variant of `numpy.remainder()`. Handles xarray objects by dispatching to the appropriate function for the underlying array type.

Documentation from numpy:

Returns the element-wise remainder of division.

Computes the remainder complementary to the floor_divide function.  It is
equivalent to the Python modulus operator `x1 % x2` and has the same sign
as the divisor x2. The MATLAB function equivalent to `np.remainder`
is `mod`.

#### WARNING
This should not be confused with:

* Python’s math.remainder and C’s `remainder`, which
  compute the IEEE remainder, which are the complement to
  `round(x1 / x2)`.
* The MATLAB `rem` function and or the C `%` operator which is the
  complement to `int(x1 / x2)`.

* **Parameters:**
  * **x1** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_like)) – Dividend array.
  * **x2** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_like)) – Divisor array.
    If `x1.shape != x2.shape`, they must be broadcastable to a common
    shape (which becomes the shape of the output).
  * **out** ([`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray), [`None`](https://docs.python.org/3/builtins/constants.html#None), or [`tuple`](https://docs.python.org/3/builtins/stdtypes.html#tuple) of [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray) and [`None`](https://docs.python.org/3/builtins/constants.html#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.
  * **where** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_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.
  * **\*\*kwargs** – For other keyword-only arguments, see the
    [ufunc docs](https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs).
* **Returns:**
  **y** ([`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – The element-wise remainder of the quotient `floor_divide(x1, x2)`.
  This is a scalar if both x1 and x2 are scalars.

#### SEE ALSO
[`floor_divide`](xarray.ufuncs.floor_divide.html.md#xarray.ufuncs.floor_divide)
: Equivalent of Python `//` operator.

[`divmod`](https://docs.python.org/3/builtins/functions.html#divmod)
: Simultaneous floor division and remainder.

[`fmod`](xarray.ufuncs.fmod.html.md#xarray.ufuncs.fmod)
: Equivalent of the MATLAB `rem` function.

[`divide`](xarray.ufuncs.divide.html.md#xarray.ufuncs.divide), [`floor`](xarray.ufuncs.floor.html.md#xarray.ufuncs.floor)

### Notes

Returns 0 when x2 is 0 and both x1 and x2 are (arrays of)
integers.
`mod` is an alias of `remainder`.

### Examples

<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIframe('7fa2f7d5-396c-4ae6-aa95-bf3eb8804d0e','d01a0644-ecce-421b-93a7-6a77e0afb6db','67fc0208-acbd-49a4-abb3-612b5fd0cd16','../lite/tree/../notebooks/index.html?path=bd20aa45_1c51_43ae_bb62_9efa5d47a6df.ipynb','None')">Try it in your browser!</button></div>
```pycon
>>> import numpy as np
>>> np.remainder([4, 7], [2, 3])
array([0, 1])
>>> np.remainder(np.arange(7), 5)
array([0, 1, 2, 3, 4, 0, 1])
```

The `%` operator can be used as a shorthand for `np.remainder` on
ndarrays.

```pycon
>>> x1 = np.arange(7)
>>> x1 % 5
array([0, 1, 2, 3, 4, 0, 1])
```

<div id="67fc0208-acbd-49a4-abb3-612b5fd0cd16" class="try_examples_outer_iframe  hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIframe('7fa2f7d5-396c-4ae6-aa95-bf3eb8804d0e','67fc0208-acbd-49a4-abb3-612b5fd0cd16')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('7fa2f7d5-396c-4ae6-aa95-bf3eb8804d0e','67fc0208-acbd-49a4-abb3-612b5fd0cd16')">Open In Tab</button></div><div id="d01a0644-ecce-421b-93a7-6a77e0afb6db" class="jupyterlite_sphinx_iframe_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script>