xarray.ufuncs.gcd

Contents

xarray.ufuncs.gcd#

xarray.ufuncs.gcd = <xarray.ufuncs._binary_ufunc object>#

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

Documentation from numpy:

Returns the greatest common divisor of |x1| and |x2|

Parameters

x1, x2 (array_like, int) – Arrays of values. If x1.shape != x2.shape, they must be broadcastable to a common shape (which becomes the shape of the output).

Returns

y (ndarray or scalar) – The greatest common divisor of the absolute value of the inputs This is a scalar if both x1 and x2 are scalars.

See also

lcm

The lowest common multiple

Examples

>>> np.gcd(12, 20)
4
>>> np.gcd.reduce([15, 25, 35])
5
>>> np.gcd(np.arange(6), 20)
array([20,  1,  2,  1,  4,  5])