Skip to content

docs: clarify role of N and in-place behavior in cumax #9959

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

Closed
YOGigx wants to merge 1 commit into from
+2 −0
Closed

docs: clarify role of N and in-place behavior in cumax #9959

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/stats/base/cumax/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,8 @@ cumax.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
## Notes

- If `N <= 0`, both functions return `y` unchanged.
- The first argument, `N`, determines how many elements are read from the input array `x` and how many results are written to the output array `y`. The function processes exactly `N` elements from `x`, advancing through the array using the specified input stride. Results are written in-place to the provided output array `y` using its stride. If `y` is larger than `N`, only the first `N` output positions are modified; all remaining elements in `y` remain unchanged.

- Depending on the environment, the typed versions ([`dcumax`][@stdlib/stats/strided/dcumax], [`scumax`][@stdlib/stats/strided/scumax], etc.) are likely to be significantly more performant.
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).

Expand Down
Loading