Skip to content

Commit a7eb96f

Browse files
authored
docs: update namespace table of contents
PR-URL: #6803 Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 22e441e commit a7eb96f

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

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

+6
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,10 @@ Other statistical functions included are:
9797

9898
<div class="namespace-toc">
9999

100+
- <span class="signature">[`cumax( x[, options] )`][@stdlib/stats/cumax]</span><span class="delimiter">: </span><span class="description">compute the cumulative maximum value along one or more ndarray dimensions.</span>
100101
- <span class="signature">[`kde2d()`][@stdlib/stats/kde2d]</span><span class="delimiter">: </span><span class="description">two-dimensional kernel density estimation.</span>
101102
- <span class="signature">[`lowess( x, y[, opts] )`][@stdlib/stats/lowess]</span><span class="delimiter">: </span><span class="description">locally-weighted polynomial regression via the LOWESS algorithm.</span>
103+
- <span class="signature">[`max( x[, options] )`][@stdlib/stats/max]</span><span class="delimiter">: </span><span class="description">compute the maximum value along one or more ndarray dimensions.</span>
102104
- <span class="signature">[`padjust( pvals, method[, comparisons] )`][@stdlib/stats/padjust]</span><span class="delimiter">: </span><span class="description">adjust supplied p-values for multiple comparisons.</span>
103105
- <span class="signature">[`ranks( arr[, opts] )`][@stdlib/stats/ranks]</span><span class="delimiter">: </span><span class="description">compute ranks for values of an array-like object.</span>
104106

@@ -143,10 +145,14 @@ console.log( objectKeys( statistics ) );
143145

144146
<!-- <toc-links> -->
145147

148+
[@stdlib/stats/cumax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/cumax
149+
146150
[@stdlib/stats/kde2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/kde2d
147151

148152
[@stdlib/stats/lowess]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/lowess
149153

154+
[@stdlib/stats/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/max
155+
150156
[@stdlib/stats/padjust]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/padjust
151157

152158
[@stdlib/stats/ranks]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/ranks

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

+9
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,11 @@ The namespace exposes the following APIs:
4545

4646
<div class="namespace-toc">
4747

48+
- <span class="signature">[`cumax( arrays )`][@stdlib/stats/base/ndarray/cumax]</span><span class="delimiter">: </span><span class="description">compute the cumulative maximum value of a one-dimensional ndarray.</span>
49+
- <span class="signature">[`dcumax( arrays )`][@stdlib/stats/base/ndarray/dcumax]</span><span class="delimiter">: </span><span class="description">compute the cumulative maximum value of a one-dimensional double-precision floating-point ndarray.</span>
4850
- <span class="signature">[`dmax( arrays )`][@stdlib/stats/base/ndarray/dmax]</span><span class="delimiter">: </span><span class="description">compute the maximum value of a one-dimensional double-precision floating-point ndarray.</span>
4951
- <span class="signature">[`max( arrays )`][@stdlib/stats/base/ndarray/max]</span><span class="delimiter">: </span><span class="description">compute the maximum value of a one-dimensional ndarray.</span>
52+
- <span class="signature">[`scumax( arrays )`][@stdlib/stats/base/ndarray/scumax]</span><span class="delimiter">: </span><span class="description">compute the cumulative maximum value of a one-dimensional single-precision floating-point ndarray.</span>
5053
- <span class="signature">[`smax( arrays )`][@stdlib/stats/base/ndarray/smax]</span><span class="delimiter">: </span><span class="description">compute the maximum value of a one-dimensional single-precision floating-point ndarray.</span>
5154

5255
</div>
@@ -90,10 +93,16 @@ console.log( objectKeys( ns ) );
9093

9194
<!-- <toc-links> -->
9295

96+
[@stdlib/stats/base/ndarray/cumax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/cumax
97+
98+
[@stdlib/stats/base/ndarray/dcumax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dcumax
99+
93100
[@stdlib/stats/base/ndarray/dmax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dmax
94101

95102
[@stdlib/stats/base/ndarray/max]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/max
96103

104+
[@stdlib/stats/base/ndarray/scumax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/scumax
105+
97106
[@stdlib/stats/base/ndarray/smax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/smax
98107

99108
<!-- </toc-links> -->

0 commit comments

Comments
 (0)