Skip to content

docs: update namespace table of contents #11738

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
kgryte merged 1 commit into from
Apr 23, 2026
Merged

docs: update namespace table of contents #11738

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
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ var o = ns;
- <span class="signature">[`coneTo( N, x, strideX )`][@stdlib/blas/ext/base/cone-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`csum( N, x, strideX )`][@stdlib/blas/ext/base/csum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements.</span>
- <span class="signature">[`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`cunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/cunitspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`czeroTo( N, x, strideX )`][@stdlib/blas/ext/base/czero-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
- <span class="signature">[`dapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a double-precision floating-point strided array.</span>
- <span class="signature">[`dapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum.</span>
Expand Down Expand Up @@ -178,6 +179,7 @@ var o = ns;
- <span class="signature">[`scusumkbn2( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/scusumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`scusumors( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/scusumors]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of single-precision floating-point strided array elements using ordinary recursive summation.</span>
- <span class="signature">[`scusumpw( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/scusumpw]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of single-precision floating-point strided array elements using pairwise summation.</span>
- <span class="signature">[`sdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/sdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a single-precision floating-point strided array.</span>
- <span class="signature">[`sdsapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sdsapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each single-precision floating-point strided array element and compute the sum using extended accumulation.</span>
- <span class="signature">[`sdsapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sdsapxsumpw]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each single-precision floating-point strided array element and compute the sum using pairwise summation with extended accumulation.</span>
- <span class="signature">[`sdsnansum( N, x, strideX )`][@stdlib/blas/ext/base/sdsnansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using extended accumulation.</span>
Expand Down Expand Up @@ -219,6 +221,7 @@ var o = ns;
- <span class="signature">[`zoneTo( N, x, strideX )`][@stdlib/blas/ext/base/zone-to]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
- <span class="signature">[`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements.</span>
- <span class="signature">[`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`zunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/zunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
- <span class="signature">[`zzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/zzero-to]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>

</div>
Expand Down Expand Up @@ -280,6 +283,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/csumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/csumkbn

[@stdlib/blas/ext/base/cunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cunitspace

[@stdlib/blas/ext/base/czero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/czero-to

[@stdlib/blas/ext/base/dapx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dapx
Expand Down Expand Up @@ -540,6 +545,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/scusumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/scusumpw

[@stdlib/blas/ext/base/sdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sdiff

[@stdlib/blas/ext/base/sdsapxsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sdsapxsum

[@stdlib/blas/ext/base/sdsapxsumpw]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sdsapxsumpw
Expand Down Expand Up @@ -622,6 +629,8 @@ console.log( objectKeys( ns ) );

[@stdlib/blas/ext/base/zsumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsumkbn

[@stdlib/blas/ext/base/zunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zunitspace

[@stdlib/blas/ext/base/zzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zzero-to

<!-- </toc-links> -->
Expand Down
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,13 @@ var o = ns;
- <span class="signature">[`quaternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW, dtypeU )`][@stdlib/ndarray/base/quaternary-tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
- <span class="signature">[`quinaryLoopOrder( shape, stridesX, stridesY, stridesZ, stridesW, stridesU, stridesV )`][@stdlib/ndarray/base/quinary-loop-interchange-order]</span><span class="delimiter">: </span><span class="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
- <span class="signature">[`quinaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW, dtypeU, dtypeV )`][@stdlib/ndarray/base/quinary-tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
- <span class="signature">[`reinterpretBoolean( x )`][@stdlib/ndarray/base/reinterpret-boolean]</span><span class="delimiter">: </span><span class="description">reinterpret a boolean ndarray as an unsigned 8-bit integer ndarray.</span>
- <span class="signature">[`reinterpretComplex128( x )`][@stdlib/ndarray/base/reinterpret-complex128]</span><span class="delimiter">: </span><span class="description">reinterpret a double-precision complex floating-point ndarray as a real-valued double-precision floating-point ndarray containing interleaved real and imaginary components.</span>
- <span class="signature">[`reinterpretComplex64( x )`][@stdlib/ndarray/base/reinterpret-complex64]</span><span class="delimiter">: </span><span class="description">reinterpret a single-precision complex floating-point ndarray as a real-valued single-precision floating-point ndarray containing interleaved real and imaginary components.</span>
- <span class="signature">[`removeSingletonDimensions( x, writable )`][@stdlib/ndarray/base/remove-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">remove singleton dimensions.</span>
- <span class="signature">[`reverseDimension( x, dim, writable )`][@stdlib/ndarray/base/reverse-dimension]</span><span class="delimiter">: </span><span class="description">return a view of an input ndarray in which the order of elements along a specified dimension is reversed.</span>
- <span class="signature">[`reverse( x, writable )`][@stdlib/ndarray/base/reverse]</span><span class="delimiter">: </span><span class="description">return a view of an input ndarray in which the order of elements along each dimension is reversed.</span>
- <span class="signature">[`rot180( x, dims, writable )`][@stdlib/ndarray/base/rot180]</span><span class="delimiter">: </span><span class="description">rotate an ndarray 180 degrees in a specified plane.</span>
- <span class="signature">[`rot90( x, dims, k, writable )`][@stdlib/ndarray/base/rot90]</span><span class="delimiter">: </span><span class="description">rotate an ndarray 90 degrees in a specified plane.</span>
- <span class="signature">[`rotl90( x, k, writable )`][@stdlib/ndarray/base/rotl90]</span><span class="delimiter">: </span><span class="description">rotate a matrix (or a stack of matrices) 90 degrees counterclockwise.</span>
- <span class="signature">[`rotr90( x, k, writable )`][@stdlib/ndarray/base/rotr90]</span><span class="delimiter">: </span><span class="description">rotate a matrix (or a stack of matrices) 90 degrees clockwise.</span>
Expand Down Expand Up @@ -539,14 +542,20 @@ console.log( objectKeys( ns ) );

[@stdlib/ndarray/base/quinary-tiling-block-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/quinary-tiling-block-size

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

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

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

[@stdlib/ndarray/base/remove-singleton-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/remove-singleton-dimensions

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

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

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

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

[@stdlib/ndarray/base/rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/rotl90
Expand Down