# xarray.ufuncs.isfinite

`xarray.ufuncs.``isfinite` = <xarray.ufuncs._UFuncDispatcher object>

  xarray specific variant of numpy.isfinite. Handles xarray.Dataset, xarray.DataArray, xarray.Variable, numpy.ndarray and dask.array.Array objects with automatic dispatching.

  Documentation from numpy:

  isfinite(x, /, out=None, *, where=True, casting=’same_kind’, order=’K’, dtype=None, subok=True[, signature, extobj])

  Test element-wise for finiteness (not infinity or not Not a Number).

  The result is returned as a boolean array.

  Parameters:

  x : array_like

  > Input values.

  out : ndarray, None, or tuple of ndarray and 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, optional

  > Values of True indicate to calculate the ufunc at that position, values of False indicate to leave the value in the output alone.

  **kwargs

  > For other keyword-only arguments, see the ufunc docs.

  Returns:

  y : ndarray, bool

  > For scalar input, the result is a new boolean with value True if the input is finite; otherwise the value is False (input is either positive infinity, negative infinity or Not a Number).

  > For array input, the result is a boolean array with the same dimensions as the input and the values are True if the corresponding element of the input is finite; otherwise the values are False (element is either positive infinity, negative infinity or Not a Number).

  See also

  `isinf`, `isneginf`, `isposinf`, `isnan`

  Notes

  Not a Number, positive infinity and negative infinity are considered to be non-finite.

  NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic (IEEE 754). This means that Not a Number is not equivalent to infinity. Also that positive infinity is not equivalent to negative infinity. But infinity is equivalent to positive infinity. Errors result if the second argument is also supplied when x is a scalar input, or if first and second arguments have different shapes.

  Examples

      >>> np.isfinite(1)
      True
      >>> np.isfinite(0)
      True
      >>> np.isfinite(np.nan)
      False
      >>> np.isfinite(np.inf)
      False
      >>> np.isfinite(np.NINF)
      False
      >>> np.isfinite([np.log(-1.),1.,np.log(0)])
      array([False,  True, False], dtype=bool)

      >>> x = np.array([-np.inf, 0., np.inf])
      >>> y = np.array([2, 2, 2])
      >>> np.isfinite(x, y)
      array([0, 1, 0])
      >>> y
      array([0, 1, 0])