Skip to content

Add signbit specification for determining whether a sign bit is set #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 2, 2023
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions spec/draft/API_specification/elementwise_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Objects in API
remainder
round
sign
signbit
sin
sinh
square
Expand Down
35 changes: 35 additions & 0 deletions src/array_api_stubs/_draft/elementwise_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"remainder",
"round",
"sign",
"signbit",
"sin",
"sinh",
"square",
Expand Down Expand Up @@ -2215,6 +2216,40 @@ def sign(x: array, /) -> array:
"""


def signbit(x: array, /) -> array:
r"""
Determines whether the sign bit is set for each element ``x_i`` of the input array ``x``.

The sign bit of a real-valued floating-point number ``x_i`` is set whenever ``x_i`` is either ``-0``, less than zero, or a signed ``NaN`` (i.e., a ``NaN`` value whose sign bit is ``1``).

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

Returns
-------
out: array
an array containing the evaluated result for each element in ``x``. The returned array must have a data type of ``bool``.

Notes
-----

**Special cases**

For real-valued floating-point operands,

- If ``x_i`` is ``+0``, the result is ``False``.
- If ``x_i`` is ``-0``, the result is ``True``.
- If ``x_i`` is ``+infinity``, the result is ``False``.
- If ``x_i`` is ``-infinity``, the result is ``True``.
- If ``x_i`` is a positive (i.e., greater than ``0``) finite number, the result is ``False``.
- If ``x_i`` is a negative (i.e., less than ``0``) finite number, the result is ``True``.
- If ``x_i`` is ``NaN`` and the sign bit of ``x_i`` is ``0``, the result is ``False``.
- If ``x_i`` is ``NaN`` and the sign bit of ``x_i`` is ``1``, the result is ``True``.
"""


def sin(x: array, /) -> array:
r"""
Calculates an implementation-dependent approximation to the sine for each element ``x_i`` of the input array ``x``.
Expand Down