Skip to content

docs: update namespace table of contents #16417

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
Planeshifter merged 1 commit into from
Nov 1, 2026
Merged

docs: update namespace table of contents #16417

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
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/math/base/special/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ var fcns = special;
- <span class="signature">[`ceilf( x )`][@stdlib/math/base/special/ceilf]</span><span class="delimiter">: </span><span class="description">round a single-precision floating-point number toward positive infinity.</span>
- <span class="signature">[`ceiln( x, n )`][@stdlib/math/base/special/ceiln]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest multiple of 10^n toward positive infinity.</span>
- <span class="signature">[`ceilsd( x, n, b )`][@stdlib/math/base/special/ceilsd]</span><span class="delimiter">: </span><span class="description">round a numeric value to the nearest number toward positive infinity with N significant figures.</span>
- <span class="signature">[`cfloor( z )`][@stdlib/math/base/special/cfloor]</span><span class="delimiter">: </span><span class="description">round a double-precision complex floating-point number toward negative infinity.</span>
- <span class="signature">[`cfloor( z )`][@stdlib/math/base/special/cfloor]</span><span class="delimiter">: </span><span class="description">round each component of a double-precision complex floating-point number toward negative infinity.</span>
- <span class="signature">[`cfloorf( z )`][@stdlib/math/base/special/cfloorf]</span><span class="delimiter">: </span><span class="description">round each component of a single-precision complex floating-point number toward negative infinity.</span>
- <span class="signature">[`cfloorn( z, n )`][@stdlib/math/base/special/cfloorn]</span><span class="delimiter">: </span><span class="description">round each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward negative infinity.</span>
- <span class="signature">[`clamp( v, min, max )`][@stdlib/math/base/special/clamp]</span><span class="delimiter">: </span><span class="description">restrict a double-precision floating-point number to a specified range.</span>
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@ The namespace contains the following multidimensional array utility functions:
- <span class="signature">[`defaults()`][@stdlib/ndarray/defaults]</span><span class="delimiter">: </span><span class="description">default ndarray settings.</span>
- <span class="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]</span><span class="delimiter">: </span><span class="description">create an ndarray function interface which performs multiple dispatch.</span>
- <span class="signature">[`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]</span><span class="delimiter">: </span><span class="description">invoke a callback function once for each ndarray element.</span>
- <span class="signature">[`arraybuffer2ndarray( dtype, buffer, shape, strides, byteOffset, order[, options] )`][@stdlib/ndarray/from-arraybuffer]</span><span class="delimiter">: </span><span class="description">create an ndarray from an ArrayBuffer.</span>
- <span class="signature">[`matrix`][@stdlib/ndarray/matrix]</span><span class="delimiter">: </span><span class="description">matrix constructors and associated utilities.</span>
- <span class="signature">[`orders()`][@stdlib/ndarray/orders]</span><span class="delimiter">: </span><span class="description">list of ndarray orders.</span>

Expand Down Expand Up @@ -335,6 +336,8 @@ console.log( objectKeys( ns ) );

[@stdlib/ndarray/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/for-each

[@stdlib/ndarray/from-arraybuffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/from-arraybuffer

[@stdlib/ndarray/matrix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix

[@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders
Expand Down
18 changes: 18 additions & 0 deletions lib/node_modules/@stdlib/ndarray/matrix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,19 @@ The namespace exports the following:

<div class="namespace-toc">

- <span class="signature">[`BooleanMatrix()`][@stdlib/ndarray/matrix/bool]</span><span class="delimiter">: </span><span class="description">create a boolean matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Complex128Matrix()`][@stdlib/ndarray/matrix/complex128]</span><span class="delimiter">: </span><span class="description">create a double-precision complex floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Complex64Matrix()`][@stdlib/ndarray/matrix/complex64]</span><span class="delimiter">: </span><span class="description">create a single-precision complex floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`matrix()`][@stdlib/ndarray/matrix/ctor]</span><span class="delimiter">: </span><span class="description">create a matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Float32Matrix()`][@stdlib/ndarray/matrix/float32]</span><span class="delimiter">: </span><span class="description">create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Float64Matrix()`][@stdlib/ndarray/matrix/float64]</span><span class="delimiter">: </span><span class="description">create a double-precision floating-point matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Int16Matrix()`][@stdlib/ndarray/matrix/int16]</span><span class="delimiter">: </span><span class="description">create a 16-bit signed integer matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Int32Matrix()`][@stdlib/ndarray/matrix/int32]</span><span class="delimiter">: </span><span class="description">create a 32-bit signed integer matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Int8Matrix()`][@stdlib/ndarray/matrix/int8]</span><span class="delimiter">: </span><span class="description">create an 8-bit signed integer matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Uint16Matrix()`][@stdlib/ndarray/matrix/uint16]</span><span class="delimiter">: </span><span class="description">create a 16-bit unsigned integer matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Uint32Matrix()`][@stdlib/ndarray/matrix/uint32]</span><span class="delimiter">: </span><span class="description">create a 32-bit unsigned integer matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Uint8Matrix()`][@stdlib/ndarray/matrix/uint8]</span><span class="delimiter">: </span><span class="description">create an 8-bit unsigned integer matrix (i.e., a two-dimensional ndarray).</span>
- <span class="signature">[`Uint8ClampedMatrix()`][@stdlib/ndarray/matrix/uint8c]</span><span class="delimiter">: </span><span class="description">create a clamped 8-bit unsigned integer matrix (i.e., a two-dimensional ndarray).</span>

</div>

Expand Down Expand Up @@ -114,6 +120,8 @@ console.log( objectKeys( ns ) );

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

[@stdlib/ndarray/matrix/bool]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/bool

[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/complex128

[@stdlib/ndarray/matrix/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/complex64
Expand All @@ -128,6 +136,16 @@ console.log( objectKeys( ns ) );

[@stdlib/ndarray/matrix/int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/int32

[@stdlib/ndarray/matrix/int8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/int8

[@stdlib/ndarray/matrix/uint16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/uint16

[@stdlib/ndarray/matrix/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/uint32

[@stdlib/ndarray/matrix/uint8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/uint8

[@stdlib/ndarray/matrix/uint8c]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/uint8c

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

</section>
Expand Down
Loading