From 34ad442975d7c3649795ed2c93bfe1cfda342b93 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Tue, 7 Apr 2026 03:24:10 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/ext/base/README.md | 9 +++++++++ lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md | 6 ++++++ lib/node_modules/@stdlib/ndarray/README.md | 3 +++ 3 files changed, 18 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 09d6197e4d9b..da540a501746 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -44,6 +44,7 @@ var o = ns;
- [`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]: fill a single-precision complex floating-point strided array with a specified scalar constant. +- [`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]: return the index of the first row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector. - [`csum( N, x, strideX )`][@stdlib/blas/ext/base/csum]: calculate the sum of single-precision complex floating-point strided array elements. - [`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]: calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm. - [`czeroTo( N, x, strideX )`][@stdlib/blas/ext/base/czero-to]: fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero. @@ -138,6 +139,7 @@ var o = ns; - [`gnansumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/gnansumkbn2]: calculate the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm. - [`gnansumors( N, x, strideX )`][@stdlib/blas/ext/base/gnansumors]: calculate the sum of strided array elements, ignoring `NaN` values and using ordinary recursive summation. - [`gnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/gnansumpw]: calculate the sum of strided array elements, ignoring `NaN` values and using pairwise summation. +- [`goneTo( N, x, strideX )`][@stdlib/blas/ext/base/gone-to]: fill a strided array with linearly spaced numeric elements which increment by `1` starting from one. - [`grev( N, x, strideX )`][@stdlib/blas/ext/base/grev]: reverse a strided array in-place. - [`gsort( N, order, x, strideX )`][@stdlib/blas/ext/base/gsort]: sort a strided array. - [`gsort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2hp]: simultaneously sort two strided arrays based on the sort order of the first array using heapsort. @@ -199,6 +201,7 @@ var o = ns; - [`wasm`][@stdlib/blas/ext/base/wasm]: extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly. - [`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]: fill a double-precision complex floating-point strided array with a specified scalar constant. - [`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]: return the index of the first row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector. +- [`zoneTo( N, x, strideX )`][@stdlib/blas/ext/base/zone-to]: fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one. - [`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]: calculate the sum of double-precision complex floating-point strided array elements. - [`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]: calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm. - [`zzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/zzero-to]: fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero. @@ -254,6 +257,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/cfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cfill +[@stdlib/blas/ext/base/cindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-row + [@stdlib/blas/ext/base/csum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/csum [@stdlib/blas/ext/base/csumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/csumkbn @@ -442,6 +447,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/gnansumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gnansumpw +[@stdlib/blas/ext/base/gone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gone-to + [@stdlib/blas/ext/base/grev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/grev [@stdlib/blas/ext/base/gsort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gsort @@ -564,6 +571,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/zindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of-row +[@stdlib/blas/ext/base/zone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zone-to + [@stdlib/blas/ext/base/zsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsum [@stdlib/blas/ext/base/zsumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsumkbn diff --git a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md index 48712b750f21..b5699d7a82ea 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -62,6 +62,7 @@ The namespace exposes the following APIs: - [`dnansumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumkbn2]: compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm. - [`dnansumors( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumors]: compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using ordinary recursive summation. - [`dnansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumpw]: compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using pairwise summation. +- [`doneTo( arrays )`][@stdlib/blas/ext/base/ndarray/done-to]: fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one. - [`dsorthp( arrays )`][@stdlib/blas/ext/base/ndarray/dsorthp]: sort a one-dimensional double-precision floating-point ndarray using heapsort. - [`dsortins( arrays )`][@stdlib/blas/ext/base/ndarray/dsortins]: sort a one-dimensional double-precision floating-point ndarray using insertion sort. - [`dsortsh( arrays )`][@stdlib/blas/ext/base/ndarray/dsortsh]: sort a one-dimensional double-precision floating-point ndarray using Shellsort. @@ -110,6 +111,7 @@ The namespace exposes the following APIs: - [`snansumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/snansumkbn2]: compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm. - [`snansumors( arrays )`][@stdlib/blas/ext/base/ndarray/snansumors]: compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using ordinary recursive summation. - [`snansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/snansumpw]: compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using pairwise summation. +- [`soneTo( arrays )`][@stdlib/blas/ext/base/ndarray/sone-to]: fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one. - [`ssorthp( arrays )`][@stdlib/blas/ext/base/ndarray/ssorthp]: sort a one-dimensional single-precision floating-point ndarray using heapsort. - [`ssum( arrays )`][@stdlib/blas/ext/base/ndarray/ssum]: compute the sum of all elements in a one-dimensional single-precision floating-point ndarray. - [`ssumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/ssumkbn]: compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm. @@ -196,6 +198,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dnansumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dnansumpw +[@stdlib/blas/ext/base/ndarray/done-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/done-to + [@stdlib/blas/ext/base/ndarray/dsorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsorthp [@stdlib/blas/ext/base/ndarray/dsortins]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsortins @@ -292,6 +296,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/snansumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/snansumpw +[@stdlib/blas/ext/base/ndarray/sone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sone-to + [@stdlib/blas/ext/base/ndarray/ssorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssorthp [@stdlib/blas/ext/base/ndarray/ssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssum diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index 2380bc0767c4..96bfe83c61c5 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -165,6 +165,7 @@ In addition, the namespace contains the following multidimensional array utility - [`ndarray2localeString( x[, locales[, options]] )`][@stdlib/ndarray/to-locale-string]: serialize an ndarray as a locale-aware string. - [`toReversedDimension( x[, options] )`][@stdlib/ndarray/to-reversed-dimension]: return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed. - [`toReversed( x )`][@stdlib/ndarray/to-reversed]: return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension. +- [`ndarray2string( x )`][@stdlib/ndarray/to-string]: serialize an ndarray as a string. - [`unshift( x, ...values )`][@stdlib/ndarray/unshift]: return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray. - [`vector`][@stdlib/ndarray/vector]: vector constructors and associated utilities. - [`ndarrayWith( x, indices, value )`][@stdlib/ndarray/with]: return a new ndarray with the element at a specified index replaced by a provided value. @@ -400,6 +401,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed +[@stdlib/ndarray/to-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-string + [@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift [@stdlib/ndarray/vector]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector