Skip to content

Commit 396d612

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

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ var o = blas;
4646
<div class="namespace-toc">
4747

4848
- <span class="signature">[`ccopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/ccopy]</span><span class="delimiter">: </span><span class="description">copy values from one complex single-precision floating-point vector to another complex single-precision floating-point vector.</span>
49+
- <span class="signature">[`cscal( N, ca, cx, strideX )`][@stdlib/blas/base/cscal]</span><span class="delimiter">: </span><span class="description">scales a single-precision complex floating-point vector by a single-precision complex floating-point constant.</span>
4950
- <span class="signature">[`cswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/cswap]</span><span class="delimiter">: </span><span class="description">interchange two complex single-precision floating-point vectors.</span>
5051
- <span class="signature">[`dasum( N, x, stride )`][@stdlib/blas/base/dasum]</span><span class="delimiter">: </span><span class="description">compute the sum of absolute values (_L1_ norm).</span>
5152
- <span class="signature">[`daxpy( N, alpha, x, strideX, y, strideY )`][@stdlib/blas/base/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a vector `x` by a constant `alpha` and add the result to `y`.</span>
@@ -72,6 +73,8 @@ var o = blas;
7273
- <span class="signature">[`srotg( a, b )`][@stdlib/blas/base/srotg]</span><span class="delimiter">: </span><span class="description">construct a Givens plane rotation.</span>
7374
- <span class="signature">[`sscal( N, alpha, x, stride )`][@stdlib/blas/base/sscal]</span><span class="delimiter">: </span><span class="description">multiply a single-precision floating-point vector `x` by a constant `alpha`.</span>
7475
- <span class="signature">[`sswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/sswap]</span><span class="delimiter">: </span><span class="description">interchange two single-precision floating-point vectors.</span>
76+
- <span class="signature">[`zcopy( N, x, strideX, y, strideY )`][@stdlib/blas/base/zcopy]</span><span class="delimiter">: </span><span class="description">copy values from one complex double-precision floating-point vector to another complex double-precision floating-point vector.</span>
77+
- <span class="signature">[`zswap( N, x, strideX, y, strideY )`][@stdlib/blas/base/zswap]</span><span class="delimiter">: </span><span class="description">interchange two complex double-precision floating-point vectors.</span>
7578

7679
</div>
7780

@@ -81,6 +84,13 @@ var o = blas;
8184

8285
<!-- <toc pattern="+(*amax|*lsame|*xerbla*)"> -->
8386

87+
<div class="namespace-toc">
88+
89+
- <span class="signature">[`idamax( N, x, strideX )`][@stdlib/blas/base/idamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value.</span>
90+
- <span class="signature">[`isamax( N, x, strideX )`][@stdlib/blas/base/isamax]</span><span class="delimiter">: </span><span class="description">find the index of the first element having the maximum absolute value.</span>
91+
92+
</div>
93+
8494
<!-- </toc> -->
8595

8696
</section>
@@ -120,8 +130,14 @@ console.log( objectKeys( blas ) );
120130

121131
<!-- <toc-links> -->
122132

133+
[@stdlib/blas/base/idamax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/idamax
134+
135+
[@stdlib/blas/base/isamax]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/isamax
136+
123137
[@stdlib/blas/base/ccopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ccopy
124138

139+
[@stdlib/blas/base/cscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/cscal
140+
125141
[@stdlib/blas/base/cswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/cswap
126142

127143
[@stdlib/blas/base/dasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dasum
@@ -174,6 +190,10 @@ console.log( objectKeys( blas ) );
174190

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

193+
[@stdlib/blas/base/zcopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zcopy
194+
195+
[@stdlib/blas/base/zswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zswap
196+
177197
<!-- </toc-links> -->
178198

179199
</section>

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ var o = ns;
4141

4242
<!-- <toc pattern="*"> -->
4343

44+
<div class="namespace-toc">
45+
46+
- <span class="signature">[`isLayout( value )`][@stdlib/blas/base/assert/is-layout]</span><span class="delimiter">: </span><span class="description">test if an input value is a BLAS memory layout.</span>
47+
- <span class="signature">[`isMatrixTriangle( value )`][@stdlib/blas/base/assert/is-matrix-triangle]</span><span class="delimiter">: </span><span class="description">test if an input value is a BLAS matrix triangle.</span>
48+
- <span class="signature">[`isTransposeOperation( value )`][@stdlib/blas/base/assert/is-transpose-operation]</span><span class="delimiter">: </span><span class="description">test if an input value is a BLAS transpose operation.</span>
49+
50+
</div>
51+
4452
<!-- </toc> -->
4553

4654
</section>
@@ -78,6 +86,16 @@ console.log( objectKeys( ns ) );
7886

7987
<section class="links">
8088

89+
<!-- <toc-links> -->
90+
91+
[@stdlib/blas/base/assert/is-layout]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/assert/is-layout
92+
93+
[@stdlib/blas/base/assert/is-matrix-triangle]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/assert/is-matrix-triangle
94+
95+
[@stdlib/blas/base/assert/is-transpose-operation]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/assert/is-transpose-operation
96+
97+
<!-- </toc-links> -->
98+
8199
</section>
82100

83101
<!-- /.links -->

0 commit comments

Comments
 (0)