Skip to content

Commit

Permalink
docs: add note regarding unspecified behavior for 0d arrays in `cumul…
Browse files Browse the repository at this point in the history
…ative_sum`

PR-URL: #851
Closes: #797
  • Loading branch information
kgryte authored Dec 12, 2024
1 parent 05ec5e7 commit 5cdcf75
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/array_api_stubs/_draft/statistical_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def cumulative_sum(
Parameters
----------
x: array
input array. Should have a numeric data type.
input array. Should have one or more dimensions (axes). Should have a numeric data type.
axis: Optional[int]
axis along which a cumulative sum must be computed. If ``axis`` is negative, the function must determine the axis along which to compute a cumulative sum by counting from the last dimension.
Expand Down Expand Up @@ -48,6 +48,8 @@ def cumulative_sum(
Notes
-----
- When ``x`` is a zero-dimensional array, behavior is unspecified and thus implementation-defined.
**Special Cases**
For both real-valued and complex floating-point operands, special cases must be handled as if the operation is implemented by successive application of :func:`~array_api.add`.
Expand Down

0 comments on commit 5cdcf75

Please sign in to comment.