Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions spec/API_specification/array_api/elementwise_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -826,17 +826,32 @@ def imag(x: array, /) -> array:

def isfinite(x: array, /) -> array:
"""
Tests each element ``x_i`` of the input array ``x`` to determine if finite (i.e., not ``NaN`` and not equal to positive or negative infinity).
Tests each element ``x_i`` of the input array ``x`` to determine if finite.

**Special Cases**

For real-valued floating-point operands,

- If ``x_i`` is either ``+infinity`` or ``-infinity``, the result is ``False``.
- If ``x_i`` is ``NaN``, the result is ``False``.
- If ``x_i`` is a finite number, the result is ``True``.

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

- If ``a`` is ``NaN`` or ``b`` is ``NaN``, the result is ``False``.
- If ``a`` is either ``+infinity`` or ``-infinity`` and ``b`` is any value, the result is ``False``.
- If ``a`` is any value and ``b`` is either ``+infinity`` or ``-infinity``, the result is ``False``.
- If ``a`` is a finite number and ``b`` is a finite number, the result is ``True``.

Parameters
----------
x: array
input array. Should have a real-valued data type.
input array. Should have a numeric data type.

Returns
-------
out: array
an array containing test results. An element ``out_i`` is ``True`` if ``x_i`` is finite and ``False`` otherwise. The returned array must have a data type of ``bool``.
an array containing test results. The returned array must have a data type of ``bool``.
"""

def isinf(x: array, /) -> array:
Expand Down