nums.numpy.isfinite

nums.numpy.isfinite(x, out=None, where=True, **kwargs)[source]

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

This docstring was copied from numpy.isfinite.

Some inconsistencies with the NumS version may exist.

The result is returned as a boolean array.

Parameters

  • x (BlockArray) – Input values.

  • out (BlockArray, None, or 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 (BlockArray, 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.

Returns

y – True where x is not positive infinity, negative infinity, or NaN; false otherwise.

Return type

BlockArray, bool

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

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

>>> nps.isfinite(nps.array(1)).get()  
array(True)
>>> nps.isfinite(nps.array(0)).get()  
array(True)
>>> nps.isfinite(nps.array(nps.nan)).get()  
array(False)
>>> nps.isfinite(nps.array(nps.inf)).get()  
array(False)
>>> nps.isfinite(nps.array(nps.NINF)).get()  
array(False)

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

previous

nums.numpy.invert

next

nums.numpy.isinf