Skip to content

Commit 248e28f

Browse files
committed
docs: clarify role of N and in-place behavior in cumax
1 parent 5ad3041 commit 248e28f

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/stats/base/cumax

lib/node_modules/@stdlib/stats/base/cumax/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ cumax.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
121121
## Notes
122122

123123
- If `N <= 0`, both functions return `y` unchanged.
124+
- 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.
125+
124126
- 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.
125127
- 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]).
126128

0 commit comments

Comments
 (0)