Skip to content

Commit 8e82087

Browse files
authored
docs: update namespace table of contents
PR-URL: #7261 Reviewed-by: Athan Reines <[email protected]>
1 parent d44b46b commit 8e82087

File tree

6 files changed

+67
-22
lines changed

6 files changed

+67
-22
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ var o = blas;
7474
- <span class="signature">[`isamax( N, x, strideX )`][@stdlib/blas/base/isamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value.</span>
7575
- <span class="signature">[`sasum( N, x, stride )`][@stdlib/blas/base/sasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (_L1_ norm).</span>
7676
- <span class="signature">[`saxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant `alpha` and add the result to `y`.</span>
77-
- <span class="signature">[`scasum( N, cx, strideX )`][@stdlib/blas/base/scasum]</span><span class="delimiter">: </span><span class="description">compute the sum of the absolute values of the real and imaginary components of a single-precision complex floating-point vector.</span>
78-
- <span class="signature">[`scnrm2( N, cx, strideX )`][@stdlib/blas/base/scnrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a complex single-precision floating-point vector.</span>
77+
- <span class="signature">[`scasum( N, x, strideX )`][@stdlib/blas/base/scasum]</span><span class="delimiter">: </span><span class="description">compute the sum of the absolute values of the real and imaginary components of a single-precision complex floating-point vector.</span>
78+
- <span class="signature">[`scnrm2( N, x, strideX )`][@stdlib/blas/base/scnrm2]</span><span class="delimiter">: </span><span class="description">compute the L2-norm of a complex single-precision floating-point vector.</span>
7979
- <span class="signature">[`scopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/scopy]</span><span class="delimiter">: </span><span class="description">copy values from `x` into `y`.</span>
8080
- <span class="signature">[`sdot( N, x, strideX, y, strideY )`][@stdlib/blas/base/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors.</span>
8181
- <span class="signature">[`sdsdot( N, scalar, x, strideX, y, strideY )`][@stdlib/blas/base/sdsdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two single-precision floating-point vectors with extended accumulation.</span>

lib/node_modules/@stdlib/number/uint16/base/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ var o = ns;
4343

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

46+
- <span class="signature">[`add( x, y )`][@stdlib/number/uint16/base/add]</span><span class="delimiter">: </span><span class="description">compute the sum of two unsigned 16-bit integers.</span>
4647
- <span class="signature">[`fromBinaryStringUint16( bstr )`][@stdlib/number/uint16/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create an unsigned 16-bit integer from a literal bit representation.</span>
48+
- <span class="signature">[`mul( x, y )`][@stdlib/number/uint16/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two unsigned 16-bit integers.</span>
49+
- <span class="signature">[`sub( x, y )`][@stdlib/number/uint16/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two unsigned 16-bit integers.</span>
4750
- <span class="signature">[`toBinaryStringUint16( x )`][@stdlib/number/uint16/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of an unsigned 16-bit integer.</span>
4851

4952
</div>
@@ -87,8 +90,14 @@ console.log( objectKeys( ns ) );
8790

8891
<!-- <toc-links> -->
8992

93+
[@stdlib/number/uint16/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/add
94+
9095
[@stdlib/number/uint16/base/from-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/from-binary-string
9196

97+
[@stdlib/number/uint16/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/mul
98+
99+
[@stdlib/number/uint16/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/sub
100+
92101
[@stdlib/number/uint16/base/to-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/to-binary-string
93102

94103
<!-- </toc-links> -->

lib/node_modules/@stdlib/number/uint8/base/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ var o = ns;
4343

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

46+
- <span class="signature">[`add( x, y )`][@stdlib/number/uint8/base/add]</span><span class="delimiter">: </span><span class="description">compute the sum of two unsigned 8-bit integers.</span>
4647
- <span class="signature">[`fromBinaryStringUint8( bstr )`][@stdlib/number/uint8/base/from-binary-string]</span><span class="delimiter">: </span><span class="description">create an unsigned 8-bit integer from a literal bit representation.</span>
48+
- <span class="signature">[`mul( x, y )`][@stdlib/number/uint8/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two unsigned 8-bit integers.</span>
49+
- <span class="signature">[`sub( x, y )`][@stdlib/number/uint8/base/sub]</span><span class="delimiter">: </span><span class="description">subtract two unsigned 8-bit integers.</span>
4750
- <span class="signature">[`toBinaryStringUint8( x )`][@stdlib/number/uint8/base/to-binary-string]</span><span class="delimiter">: </span><span class="description">return a string giving the literal bit representation of an unsigned 8-bit integer.</span>
4851

4952
</div>
@@ -87,8 +90,14 @@ console.log( objectKeys( ns ) );
8790

8891
<!-- <toc-links> -->
8992

93+
[@stdlib/number/uint8/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/add
94+
9095
[@stdlib/number/uint8/base/from-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/from-binary-string
9196

97+
[@stdlib/number/uint8/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/mul
98+
99+
[@stdlib/number/uint8/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/sub
100+
92101
[@stdlib/number/uint8/base/to-binary-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/to-binary-string
93102

94103
<!-- </toc-links> -->

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,11 @@ The namespace exports the following:
7171
- <span class="signature">[`nanmaxBy( x, clbk[, thisArg] )`][@stdlib/stats/array/nanmax-by]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of an array via a callback function, ignoring `NaN` values.</span>
7272
- <span class="signature">[`nanmax( x )`][@stdlib/stats/array/nanmax]</span><span class="delimiter">: </span><span class="description">calculate the maximum value of an array, ignoring `NaN` values.</span>
7373
- <span class="signature">[`nanmaxabs( x )`][@stdlib/stats/array/nanmaxabs]</span><span class="delimiter">: </span><span class="description">calculate the maximum absolute value of an array, ignoring `NaN` values.</span>
74+
- <span class="signature">[`nanminBy( x, clbk[, thisArg] )`][@stdlib/stats/array/nanmin-by]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of an array via a callback function, ignoring `NaN` values.</span>
7475
- <span class="signature">[`nanmin( x )`][@stdlib/stats/array/nanmin]</span><span class="delimiter">: </span><span class="description">calculate the minimum value of an array, ignoring `NaN` values.</span>
76+
- <span class="signature">[`nanminabs( x )`][@stdlib/stats/array/nanminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of an array, ignoring `NaN` values.</span>
7577
- <span class="signature">[`nanrange( x )`][@stdlib/stats/array/nanrange]</span><span class="delimiter">: </span><span class="description">calculate the range of an array, ignoring `NaN` values.</span>
78+
- <span class="signature">[`range( x )`][@stdlib/stats/array/range]</span><span class="delimiter">: </span><span class="description">calculate the range of an array.</span>
7679
- <span class="signature">[`varianceyc( x[, correction] )`][@stdlib/stats/array/varianceyc]</span><span class="delimiter">: </span><span class="description">calculate the variance of an array using a one-pass algorithm proposed by Youngs and Cramer.</span>
7780

7881
</div>
@@ -158,10 +161,16 @@ console.log( objectKeys( ns ) );
158161

159162
[@stdlib/stats/array/nanmaxabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanmaxabs
160163

164+
[@stdlib/stats/array/nanmin-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanmin-by
165+
161166
[@stdlib/stats/array/nanmin]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanmin
162167

168+
[@stdlib/stats/array/nanminabs]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanminabs
169+
163170
[@stdlib/stats/array/nanrange]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/nanrange
164171

172+
[@stdlib/stats/array/range]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/range
173+
165174
[@stdlib/stats/array/varianceyc]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/array/varianceyc
166175

167176
<!-- </toc-links> -->

0 commit comments

Comments
 (0)