nlcpy.isinf

nlcpy.isinf = <ufunc 'nlcpy_isinf'>

Tests whether input elements are inf, or not.

The result is returned as a boolean array.

Parameters

xarray_like

Input an array or a scalar, containing the elements to be tested.

outndarray or 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.

wherearray_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 section Optional Keyword Arguments.

Returns

yndarray

True where x is not positive or negative infinity, False otherwise. x is a scalar, this function returns the result as a 0-dimension ndarray.

See also

isfinite

Tests whether input elements are neither inf nor nan, or not.

isnan

Tests whether input elements are nan, or not.

Note

NLCPy uses the IEEE Standard for Binary Floating-Point for Arithmetic (IEEE754).

Examples

>>> import nlcpy as vp
>>> vp.isinf(vp.inf)
array(True)
>>> vp.isinf(vp.nan)
array(False)
>>> vp.isinf(vp.NINF)
array(True)
>>> vp.isinf([vp.inf, -vp.inf, 1.0, vp.nan])
array([ True,  True, False, False])
>>> x = vp.array([-vp.inf, 0., vp.inf])
>>> y = vp.array([2, 2, 2])
>>> vp.isinf(x)
array([ True, False,  True])
>>> vp.isinf(y)
array([False, False, False])