# xarray.ufuncs.hypot

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

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

Documentation from numpy:

Given the “legs” of a right triangle, return its hypotenuse.

Equivalent to `sqrt(x1**2 + x2**2)`, element-wise.  If x1 or
x2 is scalar_like (i.e., unambiguously cast-able to a scalar type),
it is broadcast for use with each element of the other argument.
(See Examples)

* **Parameters:**
  * **x1, x2** ([array_like](https://numpy.org/doc/stable/glossary.html#term-array_like)) – Leg of the triangle(s).
    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:**
  **z** ([`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray)) – The hypotenuse of the triangle(s).
  This is a scalar if both x1 and x2 are scalars.

### Examples

<div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesShowIframe('dc5e78d7-63d9-4d44-85c8-f1beefd2f16f','5ac9daa0-b6ec-418a-88b4-f8433c50ca33','0143fe0a-4655-49f8-a164-2ba14c4053fa','../lite/tree/../notebooks/index.html?path=de8bdf0c_d6f9_4247_96ac_2be1248abee1.ipynb','None')">Try it in your browser!</button></div>
```pycon
>>> import numpy as np
>>> np.hypot(3*np.ones((3, 3)), 4*np.ones((3, 3)))
array([[ 5.,  5.,  5.],
       [ 5.,  5.,  5.],
       [ 5.,  5.,  5.]])
```

Example showing broadcast of scalar_like argument:

```pycon
>>> np.hypot(3*np.ones((3, 3)), [4])
array([[ 5.,  5.,  5.],
       [ 5.,  5.,  5.],
       [ 5.,  5.,  5.]])
```

<div id="0143fe0a-4655-49f8-a164-2ba14c4053fa" class="try_examples_outer_iframe  hidden"><div class="try_examples_button_container"><button class="try_examples_button" onclick="window.tryExamplesHideIframe('dc5e78d7-63d9-4d44-85c8-f1beefd2f16f','0143fe0a-4655-49f8-a164-2ba14c4053fa')">Go Back</button><button class="try_examples_button" onclick="window.openInNewTab('dc5e78d7-63d9-4d44-85c8-f1beefd2f16f','0143fe0a-4655-49f8-a164-2ba14c4053fa')">Open In Tab</button></div><div id="5ac9daa0-b6ec-418a-88b4-f8433c50ca33" class="jupyterlite_sphinx_iframe_container"></div></div><script>document.addEventListener("DOMContentLoaded", function() {window.loadTryExamplesConfig("../try_examples.json");});</script>
