From f29e0b3bf0231d3cda1b28524ae7bfc55825289d Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sat, 15 Nov 2025 02:47:39 +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/README.md | 9 +++++++++ lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md | 9 +++++++++ lib/node_modules/@stdlib/ndarray/base/README.md | 3 +++ 3 files changed, 21 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/README.md b/lib/node_modules/@stdlib/blas/ext/README.md index b6fac8b84b21..77bf125b3814 100644 --- a/lib/node_modules/@stdlib/blas/ext/README.md +++ b/lib/node_modules/@stdlib/blas/ext/README.md @@ -50,7 +50,10 @@ The namespace contains the following: - [`findIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]: return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function. - [`findLastIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]: return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function. - [`indexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of]: return the first index of a specified search element along an ndarray dimension. +- [`lastIndexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of]: return the last index of a specified search element along an ndarray dimension. +- [`sorthp( x[, sortOrder][, options] )`][@stdlib/blas/ext/sorthp]: sort an input ndarray along one or more ndarray dimensions using heapsort. - [`sum( x[, options] )`][@stdlib/blas/ext/sum]: compute the sum along one or more ndarray dimensions. +- [`toSortedhp( x[, sortOrder][, options] )`][@stdlib/blas/ext/to-sortedhp]: return a new ndarray containing the elements of an input ndarray sorted along one or more ndarray dimensions using heapsort. @@ -103,8 +106,14 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/index-of +[@stdlib/blas/ext/last-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/last-index-of + +[@stdlib/blas/ext/sorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/sorthp + [@stdlib/blas/ext/sum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/sum +[@stdlib/blas/ext/to-sortedhp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/to-sortedhp + 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 f6d8ec43697c..99ecedd32a50 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md @@ -49,6 +49,7 @@ The namespace exposes the following APIs: - [`dcusum( arrays )`][@stdlib/blas/ext/base/ndarray/dcusum]: compute the cumulative sum of a one-dimensional double-precision floating-point ndarray. - [`dindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/dindex-of]: return the first index of a search element in a one-dimensional double-precision floating-point ndarray. - [`dlastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/dlast-index-of]: return the last index of a search element in a one-dimensional double-precision floating-point ndarray. +- [`dlinspace( arrays )`][@stdlib/blas/ext/base/ndarray/dlinspace]: fill a one-dimensional double-precision floating-point ndarray with linearly spaced values over a specified interval. - [`dsorthp( arrays )`][@stdlib/blas/ext/base/ndarray/dsorthp]: sort a one-dimensional double-precision floating-point ndarray using heapsort. - [`dsum( arrays )`][@stdlib/blas/ext/base/ndarray/dsum]: compute the sum of all elements in a one-dimensional double-precision floating-point ndarray. - [`gcusum( arrays )`][@stdlib/blas/ext/base/ndarray/gcusum]: compute the cumulative sum of a one-dimensional ndarray. @@ -56,11 +57,13 @@ The namespace exposes the following APIs: - [`gfindLastIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-last-index]: return the index of the last element in a one-dimensional ndarray which passes a test implemented by a predicate function. - [`gindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/gindex-of]: return the first index of a search element in a one-dimensional ndarray. - [`glastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/glast-index-of]: return the last index of a search element in a one-dimensional ndarray. +- [`glinspace( arrays )`][@stdlib/blas/ext/base/ndarray/glinspace]: fill a one-dimensional ndarray with linearly spaced values over a specified interval. - [`gsorthp( arrays )`][@stdlib/blas/ext/base/ndarray/gsorthp]: sort a one-dimensional ndarray using heapsort. - [`gsum( arrays )`][@stdlib/blas/ext/base/ndarray/gsum]: compute the sum of all elements in a one-dimensional ndarray. - [`scusum( arrays )`][@stdlib/blas/ext/base/ndarray/scusum]: compute the cumulative sum of a one-dimensional single-precision floating-point ndarray. - [`sindexOf( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of]: return the first index of a search element in a one-dimensional single-precision floating-point ndarray. - [`slastIndexOf( arrays )`][@stdlib/blas/ext/base/ndarray/slast-index-of]: return the last index of a search element in a one-dimensional single-precision floating-point ndarray. +- [`slinspace( arrays )`][@stdlib/blas/ext/base/ndarray/slinspace]: fill a one-dimensional single-precision floating-point ndarray with linearly spaced values over a specified interval. - [`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. - [`zsum( arrays )`][@stdlib/blas/ext/base/ndarray/zsum]: compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray. @@ -114,6 +117,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/dlast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlast-index-of +[@stdlib/blas/ext/base/ndarray/dlinspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dlinspace + [@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/dsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsum @@ -128,6 +133,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/glast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glast-index-of +[@stdlib/blas/ext/base/ndarray/glinspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/glinspace + [@stdlib/blas/ext/base/ndarray/gsorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gsorthp [@stdlib/blas/ext/base/ndarray/gsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gsum @@ -138,6 +145,8 @@ console.log( objectKeys( ns ) ); [@stdlib/blas/ext/base/ndarray/slast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/slast-index-of +[@stdlib/blas/ext/base/ndarray/slinspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/slinspace + [@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/base/README.md b/lib/node_modules/@stdlib/ndarray/base/README.md index 042158800470..52e31c43cb78 100644 --- a/lib/node_modules/@stdlib/ndarray/base/README.md +++ b/lib/node_modules/@stdlib/ndarray/base/README.md @@ -67,6 +67,7 @@ var o = ns; - [`bytesPerElement( dtype )`][@stdlib/ndarray/base/bytes-per-element]: return the number of bytes per element for a provided underlying ndarray data type. - [`char2dtype( [ch] )`][@stdlib/ndarray/base/char2dtype]: return the data type string associated with a provided single letter character abbreviation. - [`clampIndex( idx, max )`][@stdlib/ndarray/base/clamp-index]: restrict an index to the interval `[0,max]`. +- [`complementShape( shape, dims )`][@stdlib/ndarray/base/complement-shape]: return the shape defined by the dimensions which are not included in a list of dimensions. - [`copy( x )`][@stdlib/ndarray/base/copy]: copy an input ndarray to a new ndarray having the same shape and data type. - [`countFalsy( arrays )`][@stdlib/ndarray/base/count-falsy]: count the number of falsy elements in an ndarray. - [`countIf( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/count-if]: count the number of elements in an ndarray which pass a test implemented by a predicate function. @@ -303,6 +304,8 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/base/clamp-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/clamp-index +[@stdlib/ndarray/base/complement-shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/complement-shape + [@stdlib/ndarray/base/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/copy [@stdlib/ndarray/base/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-falsy