Skip to content

docs: clarify type promotion behavior in diff #881

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.

Sign up for GitHub

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 2 commits into from
Jan 20, 2025
Merged

docs: clarify type promotion behavior in diff #881

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcaf193
docs: clarify type promotion behavior in `diff`
kgryte Jan 9, 2025
e09b14e
refactor: loosen restrictions to allow type promotion (ala NumPy)
kgryte Jan 9, 2025
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 src/array_api_stubs/_draft/utility_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,5 @@ def diff(
-----

- The first-order differences are given by ``out[i] = x[i+1] - x[i]`` along a specified axis. Higher-order differences must be calculated recursively (e.g., by calling ``diff(out, axis=axis, n=n-1)``).
- If a conforming implementation chooses to support ``prepend`` and ``append`` arrays which have a different data type than ``x``, behavior is unspecified and thus implementation-defined. Implementations may choose to type promote (:ref:`type-promotion`), cast ``prepend`` and/or ``append`` to the same data type as ``x``, or raise an exception.
"""
Loading