Skip to content

Commit e34b36c

Browse files
docs: update namespace table of contents
PR-URL: #11855 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 6b16c0b commit e34b36c

3 files changed

Lines changed: 9 additions & 0 deletions

File tree

lib/node_modules/@stdlib/blas/base/ndarray/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ The namespace exposes the following APIs:
6060
- <span class="signature">[`saxpy( arrays )`][@stdlib/blas/base/ndarray/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision floating-point ndarray `y`.</span>
6161
- <span class="signature">[`scopy( arrays )`][@stdlib/blas/base/ndarray/scopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional single-precision floating-point ndarray `x` into a one-dimensional single-precision floating-point ndarray `y`.</span>
6262
- <span class="signature">[`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays.</span>
63+
- <span class="signature">[`sswap( arrays )`][@stdlib/blas/base/ndarray/sswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional single-precision floating-point ndarrays.</span>
6364
- <span class="signature">[`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision complex floating-point ndarray `y`.</span>
6465
- <span class="signature">[`zcopy( arrays )`][@stdlib/blas/base/ndarray/zcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`.</span>
6566

@@ -134,6 +135,8 @@ console.log( objectKeys( ns ) );
134135

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

138+
[@stdlib/blas/base/ndarray/sswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sswap
139+
137140
[@stdlib/blas/base/ndarray/zaxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zaxpy
138141

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

lib/node_modules/@stdlib/blas/ext/base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ var o = ns;
175175
- <span class="signature">[`sapxsumors( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumors]</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 ordinary recursive summation.</span>
176176
- <span class="signature">[`sapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sapxsumpw]</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.</span>
177177
- <span class="signature">[`sasumpw( N, x, strideX )`][@stdlib/blas/ext/base/sasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of single-precision floating-point strided array elements using pairwise summation.</span>
178+
- <span class="signature">[`scartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/scartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a single-precision floating-point strided array.</span>
178179
- <span class="signature">[`scircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/scircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a single-precision floating-point strided array by a specified number of positions.</span>
179180
- <span class="signature">[`scusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/scusum]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of single-precision floating-point strided array elements.</span>
180181
- <span class="signature">[`scusumkbn( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/scusumkbn]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of single-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
@@ -540,6 +541,8 @@ console.log( objectKeys( ns ) );
540541

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

544+
[@stdlib/blas/ext/base/scartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/scartesian-square
545+
543546
[@stdlib/blas/ext/base/scircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/scircshift
544547

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

lib/node_modules/@stdlib/ndarray/base/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ var o = ns;
168168
- <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>
169169
- <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>
170170
- <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>
171+
- <span class="signature">[`reinterpretComplex( x )`][@stdlib/ndarray/base/reinterpret-complex]</span><span class="delimiter">: </span><span class="description">reinterpret a complex-valued floating-point ndarray as a real-valued floating-point ndarray having the same precision.</span>
171172
- <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>
172173
- <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>
173174
- <span class="signature">[`removeSingletonDimensions( x, writable )`][@stdlib/ndarray/base/remove-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">remove singleton dimensions.</span>
@@ -551,6 +552,8 @@ console.log( objectKeys( ns ) );
551552

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

555+
[@stdlib/ndarray/base/reinterpret-complex]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reinterpret-complex
556+
554557
[@stdlib/ndarray/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reinterpret-complex128
555558

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

0 commit comments

Comments
 (0)