Skip to content

Commit 973f832

Browse files
authored
docs: update namespace table of contents
PR-URL: #11738 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 538ced0 commit 973f832

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ var o = ns;
4848
- <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>
4949
- <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>
5050
- <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>
51+
- <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>
5152
- <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>
5253
- <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>
5354
- <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>
@@ -178,6 +179,7 @@ var o = ns;
178179
- <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>
179180
- <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>
180181
- <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>
182+
- <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>
181183
- <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>
182184
- <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>
183185
- <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>
@@ -219,6 +221,7 @@ var o = ns;
219221
- <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>
220222
- <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>
221223
- <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>
224+
- <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>
222225
- <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>
223226

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

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

286+
[@stdlib/blas/ext/base/cunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cunitspace
287+
283288
[@stdlib/blas/ext/base/czero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/czero-to
284289

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

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

548+
[@stdlib/blas/ext/base/sdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sdiff
549+
543550
[@stdlib/blas/ext/base/sdsapxsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sdsapxsum
544551

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

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

632+
[@stdlib/blas/ext/base/zunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zunitspace
633+
625634
[@stdlib/blas/ext/base/zzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zzero-to
626635

627636
<!-- </toc-links> -->

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,13 @@ var o = ns;
166166
- <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>
167167
- <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>
168168
- <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>
169+
- <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>
169170
- <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>
171+
- <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>
170172
- <span class="signature">[`removeSingletonDimensions( x, writable )`][@stdlib/ndarray/base/remove-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">remove singleton dimensions.</span>
171173
- <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>
172174
- <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>
175+
- <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>
173176
- <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>
174177
- <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>
175178
- <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>
@@ -539,14 +542,20 @@ console.log( objectKeys( ns ) );
539542

540543
[@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
541544

545+
[@stdlib/ndarray/base/reinterpret-boolean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reinterpret-boolean
546+
542547
[@stdlib/ndarray/base/reinterpret-complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reinterpret-complex128
543548

549+
[@stdlib/ndarray/base/reinterpret-complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reinterpret-complex64
550+
544551
[@stdlib/ndarray/base/remove-singleton-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/remove-singleton-dimensions
545552

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

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

557+
[@stdlib/ndarray/base/rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/rot180
558+
550559
[@stdlib/ndarray/base/rot90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/rot90
551560

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

0 commit comments

Comments
 (0)