Skip to content

Commit 10210e4

Browse files
authored
docs: update namespace table of contents
PR-URL: #11497 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 737511b commit 10210e4

4 files changed

Lines changed: 51 additions & 0 deletions

File tree

lib/node_modules/@stdlib/blas/ext/base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ var o = ns;
189189
- <span class="signature">[`snansumpw( N, x, strideX )`][@stdlib/blas/ext/base/snansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.</span>
190190
- <span class="signature">[`soneTo( N, x, strideX )`][@stdlib/blas/ext/base/sone-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
191191
- <span class="signature">[`srev( N, x, strideX )`][@stdlib/blas/ext/base/srev]</span><span class="delimiter">: </span><span class="description">reverse a single-precision floating-point strided array in-place.</span>
192+
- <span class="signature">[`ssort( N, order, x, strideX )`][@stdlib/blas/ext/base/ssort]</span><span class="delimiter">: </span><span class="description">sort a single-precision floating-point strided array.</span>
192193
- <span class="signature">[`ssort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using heapsort.</span>
193194
- <span class="signature">[`ssort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>
194195
- <span class="signature">[`ssort2sh( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2sh]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using Shellsort.</span>
@@ -550,6 +551,8 @@ console.log( objectKeys( ns ) );
550551

551552
[@stdlib/blas/ext/base/srev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/srev
552553

554+
[@stdlib/blas/ext/base/ssort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssort
555+
553556
[@stdlib/blas/ext/base/ssort2hp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssort2hp
554557

555558
[@stdlib/blas/ext/base/ssort2ins]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssort2ins

lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The namespace exposes the following APIs:
6464
- <span class="signature">[`dnansumors( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using ordinary recursive summation.</span>
6565
- <span class="signature">[`dnansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using pairwise summation.</span>
6666
- <span class="signature">[`doneTo( arrays )`][@stdlib/blas/ext/base/ndarray/done-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
67+
- <span class="signature">[`dsort( arrays )`][@stdlib/blas/ext/base/ndarray/dsort]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray.</span>
6768
- <span class="signature">[`dsorthp( arrays )`][@stdlib/blas/ext/base/ndarray/dsorthp]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray using heapsort.</span>
6869
- <span class="signature">[`dsortins( arrays )`][@stdlib/blas/ext/base/ndarray/dsortins]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray using insertion sort.</span>
6970
- <span class="signature">[`dsortsh( arrays )`][@stdlib/blas/ext/base/ndarray/dsortsh]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray using Shellsort.</span>
@@ -114,6 +115,7 @@ The namespace exposes the following APIs:
114115
- <span class="signature">[`snansumors( arrays )`][@stdlib/blas/ext/base/ndarray/snansumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using ordinary recursive summation.</span>
115116
- <span class="signature">[`snansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/snansumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using pairwise summation.</span>
116117
- <span class="signature">[`soneTo( arrays )`][@stdlib/blas/ext/base/ndarray/sone-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
118+
- <span class="signature">[`ssort( arrays )`][@stdlib/blas/ext/base/ndarray/ssort]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional single-precision floating-point ndarray.</span>
117119
- <span class="signature">[`ssorthp( arrays )`][@stdlib/blas/ext/base/ndarray/ssorthp]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional single-precision floating-point ndarray using heapsort.</span>
118120
- <span class="signature">[`ssum( arrays )`][@stdlib/blas/ext/base/ndarray/ssum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray.</span>
119121
- <span class="signature">[`ssumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/ssumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
@@ -205,6 +207,8 @@ console.log( objectKeys( ns ) );
205207

206208
[@stdlib/blas/ext/base/ndarray/done-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/done-to
207209

210+
[@stdlib/blas/ext/base/ndarray/dsort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsort
211+
208212
[@stdlib/blas/ext/base/ndarray/dsorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsorthp
209213

210214
[@stdlib/blas/ext/base/ndarray/dsortins]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsortins
@@ -305,6 +309,8 @@ console.log( objectKeys( ns ) );
305309

306310
[@stdlib/blas/ext/base/ndarray/sone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sone-to
307311

312+
[@stdlib/blas/ext/base/ndarray/ssort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssort
313+
308314
[@stdlib/blas/ext/base/ndarray/ssorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssorthp
309315

310316
[@stdlib/blas/ext/base/ndarray/ssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssum

lib/node_modules/@stdlib/math/base/tools/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ var o = tools;
4343

4444
<div class="namespace-toc">
4545

46+
- <span class="signature">[`chebyshevSeries( x, c )`][@stdlib/math/base/tools/chebyshev-series]</span><span class="delimiter">: </span><span class="description">evaluate a Chebyshev series using double-precision floating-point arithmetic.</span>
4647
- <span class="signature">[`continuedFraction( generator[, options ] )`][@stdlib/math/base/tools/continued-fraction]</span><span class="delimiter">: </span><span class="description">continued fraction approximation.</span>
4748
- <span class="signature">[`evalpoly( c, x )`][@stdlib/math/base/tools/evalpoly]</span><span class="delimiter">: </span><span class="description">evaluate a polynomial using double-precision floating-point arithmetic.</span>
4849
- <span class="signature">[`evalpolyf( c, x )`][@stdlib/math/base/tools/evalpolyf]</span><span class="delimiter">: </span><span class="description">evaluate a polynomial using single-precision floating-point arithmetic.</span>
@@ -96,6 +97,8 @@ console.log( objectKeys( tools ) );
9697

9798
<!-- <toc-links> -->
9899

100+
[@stdlib/math/base/tools/chebyshev-series]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/chebyshev-series
101+
99102
[@stdlib/math/base/tools/continued-fraction]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/continued-fraction
100103

101104
[@stdlib/math/base/tools/evalpoly]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/tools/evalpoly

0 commit comments

Comments
 (0)