Ctrl+K

isinf#

ivy.isinf(x, /, *, detect_positive=True, detect_negative=True, out=None)[source]#

Test each element x_i of the input array x to determine if equal to positive or negative infinity.

Parameters:

  • x (Union[Array, NativeArray]) – input array. Should have a numeric data type.

  • detect_positive (bool, default: True) – if True, positive infinity is detected.

  • detect_negative (bool, default: True) – if True, negative infinity is detected.

  • out (Optional[Array], default: None) – optional output array, for writing the result to. It must have a shape that the inputs broadcast to.

Return type:

Array

Returns:

ret – an array containing test results. An element out_i is True if x_i is either positive or negative infinity and False otherwise. The returned array must have a data type of bool.

Special Cases

For real-valued floating-point operands,

  • If x_i is either +infinity or -infinity, the result is True.

  • In the remaining cases, the result is False.

For complex floating-point operands, let a = real(x_i), b = imag(x_i), and

  • If a is either +infinity or -infinity and b is any value (including NaN), the result is True.

  • If a is either a finite number or NaN and b is either +infinity or -infinity, the result is True.

  • In the remaining cases, the result is False.

This function conforms to the Array API Standard. This docstring is an extension of the docstring in the standard.

Both the description and the type hints above assumes an array input for simplicity, but this function is nestable, and therefore also accepts ivy.Container instances in place of any of the arguments.

Examples

With ivy.Array inputs:

>>> x = ivy.array([1, 2, 3])
>>> z = ivy.isinf(x)
>>> print(z)
ivy.array([False, False, False])

>>> x = ivy.array([[1.1, 2.3, -3.6]])
>>> z = ivy.isinf(x)
>>> print(z)
ivy.array([[False, False, False]])

>>> x = ivy.array([[[1.1], [float('inf')], [-6.3]]])
>>> z = ivy.isinf(x)
>>> print(z)
ivy.array([[[False],
        [True],
        [False]]])

>>> x = ivy.array([[-float('inf'), float('inf'), 0.0]])
>>> z = ivy.isinf(x)
>>> print(z)
ivy.array([[ True,  True, False]])

>>> x = ivy.zeros((3, 3))
>>> z = ivy.isinf(x)
>>> print(z)
ivy.array([[False, False, False],
   [False, False, False],
   [False, False, False]])

With ivy.Container input:

>>> x = ivy.Container(a=ivy.array([-1, -float('inf'), 1.23]),
...                   b=ivy.array([float('inf'), 3.3, -4.2]))
>>> z = ivy.isinf(x)
>>> print(z)
{
    a: ivy.array([False, True, False]),
    b: ivy.array([True, False, False])
}

With ivy.Container input:

>>> x = ivy.Container(a=ivy.array([-1, -float('inf'), 1.23]),
...                   b=ivy.array([float('inf'), 3.3, -4.2]))
>>> x.isinf()
{
    a: ivy.array([False, True, False]),
    b: ivy.array([True, False, False])
}
Array.isinf(self, *, detect_positive=True, detect_negative=True, out=None)[source]#

ivy.Array instance method variant of ivy.isinf. This method simply wraps the function, and so the docstring for ivy.isinf also applies to this method with minimal changes.

Parameters:

  • self (Array) – input array. Should have a real-valued data type.

  • detect_positive (bool, default: True) – if True, positive infinity is detected.

  • detect_negative (bool, default: True) – if True, negative infinity is detected.

  • out (Optional[Array], default: None) – optional output array, for writing the result to. It must have a shape that the inputs broadcast to.

Return type:

Array

Returns:

ret – an array containing test results. An element out_i is True if self_i is either positive or negative infinity and False otherwise. The returned array must have a data type of bool.

Examples

With ivy.Array inputs:

>>> x = ivy.array([1, 2, 3])
>>> x.isinf()
ivy.array([False, False, False])

>>> x = ivy.array([[1.1, 2.3, -3.6]])
>>> x.isinf()
ivy.array([[False, False, False]])

>>> x = ivy.array([[[1.1], [float('inf')], [-6.3]]])
>>> x.isinf()
ivy.array([[[False],[True],[False]]])

>>> x = ivy.array([[-float('inf'), float('inf'), 0.0]])
>>> x.isinf()
ivy.array([[ True, True, False]])

>>> x = ivy.zeros((3, 3))
>>> x.isinf()
ivy.array([[False, False, False],
    [False, False, False],
    [False, False, False]])
Container.isinf(self, *, detect_positive=True, detect_negative=True, key_chains=None, to_apply=True, prune_unapplied=False, map_sequences=False, out=None)[source]#

ivy.Container instance method variant of ivy.isinf. This method simply wraps the function, and so the docstring for ivy.isinf also applies to this method with minimal changes.

Parameters:

  • self (Container) – input container. Should have a real-valued data type.

  • detect_positive (Union[bool, Container], default: True) – if True, positive infinity is detected.

  • detect_negative (Union[bool, Container], default: True) – if True, negative infinity is detected.

  • key_chains (Optional[Union[List[str], Dict[str, str], Container]], default: None) – The key-chains to apply or not apply the method to. Default is None.

  • to_apply (Union[bool, Container], default: True) – If True, the method will be applied to key_chains, otherwise key_chains will be skipped. Default is True.

  • prune_unapplied (Union[bool, Container], default: False) – Whether to prune key_chains for which the function was not applied. Default is False.

  • map_sequences (Union[bool, Container], default: False) – Whether to also map method to sequences (lists, tuples). Default is False.

  • out (Optional[Container], default: None) – optional output container, for writing the result to. It must have a shape that the inputs broadcast to.

Return type:

Container

Returns:

ret – a container containing the test result. An element out_i is True if self_i is either positive or negative infinity and False otherwise. The returned array must have a data type of bool.

Examples

With ivy.Container input:

>>> x = ivy.Container(a=ivy.array([-1, -float('inf'), 1.23]),
...                   b=ivy.array([float('inf'), 3.3, -4.2]))
>>> z = x.isinf()
>>> print(z)
{
    a: ivy.array([False, True, False]),
    b: ivy.array([True, False, False])
}
On this page