Skip to content

docs: update namespace table of contents #7261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 8, 2025
Merged

docs: update namespace table of contents #7261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/blas/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ var o = blas;
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/number/uint16/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ var o = ns;

<div class="namespace-toc">

- <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>
- <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>
- <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>
- <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>
- <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>

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

<!-- <toc-links> -->

[@stdlib/number/uint16/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/add

[@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

[@stdlib/number/uint16/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/mul

[@stdlib/number/uint16/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint16/base/sub

[@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

<!-- </toc-links> -->
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/number/uint8/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,10 @@ var o = ns;

<div class="namespace-toc">

- <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>
- <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>
- <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>
- <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>
- <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>

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

<!-- <toc-links> -->

[@stdlib/number/uint8/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/add

[@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

[@stdlib/number/uint8/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/mul

[@stdlib/number/uint8/base/sub]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/number/uint8/base/sub

[@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

<!-- </toc-links> -->
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/stats/array/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,11 @@ The namespace exports the following:
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <span class="signature">[`range( x )`][@stdlib/stats/array/range]</span><span class="delimiter">: </span><span class="description">calculate the range of an array.</span>
- <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>

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

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

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

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

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

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

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

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

<!-- </toc-links> -->
Expand Down
Loading