From e853f57e6c187ae02fcd037a786d91ec2dd7c579 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sun, 1 Nov 2026 02:32:39 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/math/base/special/README.md | 2 +- lib/node_modules/@stdlib/ndarray/README.md | 3 +++ .../@stdlib/ndarray/matrix/README.md | 18 ++++++++++++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/math/base/special/README.md b/lib/node_modules/@stdlib/math/base/special/README.md index 301c207472c0..111dce9c450c 100644 --- a/lib/node_modules/@stdlib/math/base/special/README.md +++ b/lib/node_modules/@stdlib/math/base/special/README.md @@ -204,7 +204,7 @@ var fcns = special; - [`ceilf( x )`][@stdlib/math/base/special/ceilf]: round a single-precision floating-point number toward positive infinity. - [`ceiln( x, n )`][@stdlib/math/base/special/ceiln]: round a numeric value to the nearest multiple of 10^n toward positive infinity. - [`ceilsd( x, n, b )`][@stdlib/math/base/special/ceilsd]: round a numeric value to the nearest number toward positive infinity with N significant figures. -- [`cfloor( z )`][@stdlib/math/base/special/cfloor]: round a double-precision complex floating-point number toward negative infinity. +- [`cfloor( z )`][@stdlib/math/base/special/cfloor]: round each component of a double-precision complex floating-point number toward negative infinity. - [`cfloorf( z )`][@stdlib/math/base/special/cfloorf]: round each component of a single-precision complex floating-point number toward negative infinity. - [`cfloorn( z, n )`][@stdlib/math/base/special/cfloorn]: round each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward negative infinity. - [`clamp( v, min, max )`][@stdlib/math/base/special/clamp]: restrict a double-precision floating-point number to a specified range. diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index cbe8502f0b2a..f63cabfbde09 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -285,6 +285,7 @@ The namespace contains the following multidimensional array utility functions: - [`defaults()`][@stdlib/ndarray/defaults]: default ndarray settings. - [`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]: create an ndarray function interface which performs multiple dispatch. - [`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]: invoke a callback function once for each ndarray element. +- [`arraybuffer2ndarray( dtype, buffer, shape, strides, byteOffset, order[, options] )`][@stdlib/ndarray/from-arraybuffer]: create an ndarray from an ArrayBuffer. - [`matrix`][@stdlib/ndarray/matrix]: matrix constructors and associated utilities. - [`orders()`][@stdlib/ndarray/orders]: list of ndarray orders. @@ -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 diff --git a/lib/node_modules/@stdlib/ndarray/matrix/README.md b/lib/node_modules/@stdlib/ndarray/matrix/README.md index 2545b51a8b39..e6be90ae2e88 100644 --- a/lib/node_modules/@stdlib/ndarray/matrix/README.md +++ b/lib/node_modules/@stdlib/ndarray/matrix/README.md @@ -55,6 +55,7 @@ The namespace exports the following:
+- [`BooleanMatrix()`][@stdlib/ndarray/matrix/bool]: create a boolean matrix (i.e., a two-dimensional ndarray). - [`Complex128Matrix()`][@stdlib/ndarray/matrix/complex128]: create a double-precision complex floating-point matrix (i.e., a two-dimensional ndarray). - [`Complex64Matrix()`][@stdlib/ndarray/matrix/complex64]: create a single-precision complex floating-point matrix (i.e., a two-dimensional ndarray). - [`matrix()`][@stdlib/ndarray/matrix/ctor]: create a matrix (i.e., a two-dimensional ndarray). @@ -62,6 +63,11 @@ The namespace exports the following: - [`Float64Matrix()`][@stdlib/ndarray/matrix/float64]: create a double-precision floating-point matrix (i.e., a two-dimensional ndarray). - [`Int16Matrix()`][@stdlib/ndarray/matrix/int16]: create a 16-bit signed integer matrix (i.e., a two-dimensional ndarray). - [`Int32Matrix()`][@stdlib/ndarray/matrix/int32]: create a 32-bit signed integer matrix (i.e., a two-dimensional ndarray). +- [`Int8Matrix()`][@stdlib/ndarray/matrix/int8]: create an 8-bit signed integer matrix (i.e., a two-dimensional ndarray). +- [`Uint16Matrix()`][@stdlib/ndarray/matrix/uint16]: create a 16-bit unsigned integer matrix (i.e., a two-dimensional ndarray). +- [`Uint32Matrix()`][@stdlib/ndarray/matrix/uint32]: create a 32-bit unsigned integer matrix (i.e., a two-dimensional ndarray). +- [`Uint8Matrix()`][@stdlib/ndarray/matrix/uint8]: create an 8-bit unsigned integer matrix (i.e., a two-dimensional ndarray). +- [`Uint8ClampedMatrix()`][@stdlib/ndarray/matrix/uint8c]: create a clamped 8-bit unsigned integer matrix (i.e., a two-dimensional ndarray).
@@ -114,6 +120,8 @@ console.log( objectKeys( ns ) ); +[@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 @@ -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 +