Skip to content

Commit 15204d7

Browse files
authored
docs: update namespace table of contents
PR-URL: #4858 Reviewed-by: Athan Reines <[email protected]>
1 parent 39c7a0a commit 15204d7

File tree

4 files changed

+11
-5
lines changed

4 files changed

+11
-5
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,10 @@ var ns = extblas;
142142
- <span class="signature">[`sfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with a specified scalar constant.</span>
143143
- <span class="signature">[`snansum( N, x, stride )`][@stdlib/blas/ext/base/snansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values.</span>
144144
- <span class="signature">[`snansumkbn( N, x, stride )`][@stdlib/blas/ext/base/snansumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.</span>
145-
- <span class="signature">[`snansumkbn2( N, x, stride )`][@stdlib/blas/ext/base/snansumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
145+
- <span class="signature">[`snansumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/snansumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
146146
- <span class="signature">[`snansumors( N, x, strideX )`][@stdlib/blas/ext/base/snansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
147147
- <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>
148-
- <span class="signature">[`srev( N, x, stride )`][@stdlib/blas/ext/base/srev]</span><span class="delimiter">: </span><span class="description">reverse a single-precision floating-point strided array in-place.</span>
148+
- <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>
149149
- <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>
150150
- <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>
151151
- <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>

lib/node_modules/@stdlib/complex/float64/base/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ The namespace contains the following functions:
5858
<div class="namespace-toc">
5959

6060
- <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float64/base/add]</span><span class="delimiter">: </span><span class="description">add two double-precision complex floating-point numbers.</span>
61+
- <span class="signature">[`muladd( alpha, x, y )`][@stdlib/complex/float64/base/mul-add]</span><span class="delimiter">: </span><span class="description">perform a multiply-add operation involving three double-precision complex floating-point numbers.</span>
6162
- <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float64/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision complex floating-point numbers.</span>
63+
- <span class="signature">[`scale( alpha, z )`][@stdlib/complex/float64/base/scale]</span><span class="delimiter">: </span><span class="description">scale a double-precision complex floating-point number by a real-valued double-precision floating-point scalar constant.</span>
6264

6365
</div>
6466

@@ -111,8 +113,12 @@ console.log( objectKeys( ns ) );
111113

112114
[@stdlib/complex/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add
113115

116+
[@stdlib/complex/float64/base/mul-add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/mul-add
117+
114118
[@stdlib/complex/float64/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/mul
115119

120+
[@stdlib/complex/float64/base/scale]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/scale
121+
116122
[@stdlib/complex/float64/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert
117123

118124
<!-- </toc-links> -->

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ The namespace contains the following packages:
4545

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

48-
- <span class="signature">[`binary( env, info, fcn )`][@stdlib/math/base/napi/binary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking binary numerical functions.</span>
48+
- <span class="signature">[`binary( fcn )`][@stdlib/math/base/napi/binary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking binary numerical functions.</span>
4949
- <span class="signature">[`quaternary( env, info, fcn )`][@stdlib/math/base/napi/quaternary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking quaternary numerical functions.</span>
5050
- <span class="signature">[`quinary( env, info, fcn )`][@stdlib/math/base/napi/quinary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking quinary numerical functions.</span>
51-
- <span class="signature">[`ternary( env, info, fcn )`][@stdlib/math/base/napi/ternary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking ternary numerical functions.</span>
51+
- <span class="signature">[`ternary( fcn )`][@stdlib/math/base/napi/ternary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking ternary numerical functions.</span>
5252
- <span class="signature">[`unary( env, info, fcn )`][@stdlib/math/base/napi/unary]</span><span class="delimiter">: </span><span class="description">C APIs for registering a Node-API module exporting interfaces for invoking unary numerical functions.</span>
5353

5454
</div>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ The namespace contains the following statistical functions:
225225
- <span class="signature">[`snanmax( N, x, strideX )`][@stdlib/stats/base/snanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of a single-precision floating-point strided array, ignoring `NaN` values.</span>
226226
- <span class="signature">[`snanmaxabs( N, x, strideX )`][@stdlib/stats/base/snanmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of a single-precision floating-point strided array, ignoring `NaN` values.</span>
227227
- <span class="signature">[`snanmean( N, x, stride )`][@stdlib/stats/base/snanmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values.</span>
228-
- <span class="signature">[`snanmeanors( N, x, stride )`][@stdlib/stats/base/snanmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation.</span>
228+
- <span class="signature">[`snanmeanors( N, x, strideX )`][@stdlib/stats/base/snanmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using ordinary recursive summation.</span>
229229
- <span class="signature">[`snanmeanpn( N, x, stride )`][@stdlib/stats/base/snanmeanpn]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using a two-pass error correction algorithm.</span>
230230
- <span class="signature">[`snanmeanwd( N, x, stride )`][@stdlib/stats/base/snanmeanwd]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring `NaN` values and using Welford's algorithm.</span>
231231
- <span class="signature">[`snanmin( N, x, strideX )`][@stdlib/stats/base/snanmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of a single-precision floating-point strided array, ignoring `NaN` values.</span>

0 commit comments

Comments
 (0)