Skip to content

Commit 3772f8f

Browse files
docs: update namespace table of contents
PR-URL: #5366 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
1 parent 0625d8e commit 3772f8f

File tree

6 files changed

+60
-41
lines changed

6 files changed

+60
-41
lines changed

Diff for: lib/node_modules/@stdlib/_tools/eslint/rules/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ var eslint = rules;
112112
- <span class="signature">[`jsdoc-doctest`][@stdlib/_tools/eslint/rules/jsdoc-doctest]</span><span class="delimiter">: </span><span class="description">ESLint rule to ensure that return annotations in example code match the actual output.</span>
113113
- <span class="signature">[`jsdoc-emphasis-marker`][@stdlib/_tools/eslint/rules/jsdoc-emphasis-marker]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce a specific Markdown emphasis marker in JSDoc descriptions.</span>
114114
- <span class="signature">[`jsdoc-empty-line-before-example`][@stdlib/_tools/eslint/rules/jsdoc-empty-line-before-example]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce empty lines before JSDoc `@example` tags.</span>
115+
- <span class="signature">[`jsdoc-example-require-spacing`][@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce empty lines between `require` statements and code in JSDoc examples.</span>
115116
- <span class="signature">[`jsdoc-fenced-code-flag`][@stdlib/_tools/eslint/rules/jsdoc-fenced-code-flag]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce fenced Markdown code blocks to have a language flag in JSDoc descriptions.</span>
116117
- <span class="signature">[`jsdoc-fenced-code-marker`][@stdlib/_tools/eslint/rules/jsdoc-fenced-code-marker]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce a specific Markdown fenced code marker in JSDoc descriptions.</span>
117118
- <span class="signature">[`jsdoc-final-definition`][@stdlib/_tools/eslint/rules/jsdoc-final-definition]</span><span class="delimiter">: </span><span class="description">ESLint rule to require Markdown definitions in JSDoc descriptions be placed at the end of the description.</span>
@@ -240,6 +241,8 @@ console.log( getKeys( rules ) );
240241

241242
[@stdlib/_tools/eslint/rules/jsdoc-empty-line-before-example]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/jsdoc-empty-line-before-example
242243

244+
[@stdlib/_tools/eslint/rules/jsdoc-example-require-spacing]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/jsdoc-example-require-spacing
245+
243246
[@stdlib/_tools/eslint/rules/jsdoc-fenced-code-flag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/jsdoc-fenced-code-flag
244247

245248
[@stdlib/_tools/eslint/rules/jsdoc-fenced-code-marker]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/jsdoc-fenced-code-marker

Diff for: lib/node_modules/@stdlib/blas/base/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ var o = blas;
8787
- <span class="signature">[`zaxpy( N, za, zx, strideX, zy, strideY )`][@stdlib/blas/base/zaxpy]</span><span class="delimiter">: </span><span class="description">scale a double-precision complex floating-point vector by a double-precision complex floating-point constant and add the result to a double-precision complex floating-point vector.</span>
8888
- <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>
8989
- <span class="signature">[`zdrot( N, zx, strideX, zy, strideY, c, s )`][@stdlib/blas/base/zdrot]</span><span class="delimiter">: </span><span class="description">applies a plane rotation.</span>
90+
- <span class="signature">[`zdscal( N, da, zx, strideZX )`][@stdlib/blas/base/zdscal]</span><span class="delimiter">: </span><span class="description">scale a double-precision complex floating-point vector by a double-precision floating-point constant.</span>
9091
- <span class="signature">[`zscal( N, alpha, x, strideX )`][@stdlib/blas/base/zscal]</span><span class="delimiter">: </span><span class="description">scales a double-precision complex floating-point vector by a double-precision complex floating-point constant.</span>
9192
- <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>
9293

@@ -100,17 +101,22 @@ var o = blas;
100101

101102
<div class="namespace-toc">
102103

104+
- <span class="signature">[`dgemv( ord, trans, M, N, α, A, LDA, x, sx, β, y, sy )`][@stdlib/blas/base/dgemv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A**T*x + β*y`.</span>
103105
- <span class="signature">[`dspmv( order, uplo, N, α, AP, x, sx, β, y, sy )`][@stdlib/blas/base/dspmv]</span><span class="delimiter">: </span><span class="description">perform the matrix-vector operation `y = α*A*x + β*y` where `α` and `β` are scalars, `x` and `y` are `N` element vectors and, `A` is an `N` by `N` symmetric matrix supplied in packed form.</span>
106+
- <span class="signature">[`dspr( order, uplo, N, α, x, sx, AP )`][@stdlib/blas/base/dspr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = α*x*x^T + A`.</span>
104107
- <span class="signature">[`dsymv( order, uplo, N, α, A, LDA, x, sx, β, y, sy )`][@stdlib/blas/base/dsymv]</span><span class="delimiter">: </span><span class="description">perform the matrix-vector operation `y = α*A*x + β*y` where `α` and `β` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` symmetric matrix.</span>
105108
- <span class="signature">[`dsyr( order, uplo, N, α, x, sx, A, LDA )`][@stdlib/blas/base/dsyr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = α*x*x^T + A`.</span>
106109
- <span class="signature">[`dsyr2( order, uplo, N, α, x, sx, y, sy, A, LDA )`][@stdlib/blas/base/dsyr2]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 2 operation `A = α*x*y^T + α*y*x^T + A`.</span>
107110
- <span class="signature">[`dtrmv( order, uplo, trans, diag, N, A, LDA, x, sx )`][@stdlib/blas/base/dtrmv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`.</span>
111+
- <span class="signature">[`dtrsv( order, uplo, trans, diag, N, A, LDA, x, sx )`][@stdlib/blas/base/dtrsv]</span><span class="delimiter">: </span><span class="description">solve one of the systems of equations `A*x = b` or `A^T*x = b`.</span>
108112
- <span class="signature">[`sgemv( ord, trans, M, N, α, A, LDA, x, sx, β, y, sy )`][@stdlib/blas/base/sgemv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y`.</span>
109113
- <span class="signature">[`sspmv( order, uplo, N, α, AP, x, sx, β, y, sy )`][@stdlib/blas/base/sspmv]</span><span class="delimiter">: </span><span class="description">perform the matrix-vector operation `y = α*A*x + β*y` where `α` and `β` are scalars, `x` and `y` are `N` element vectors and, `A` is an `N` by `N` symmetric matrix supplied in packed form.</span>
114+
- <span class="signature">[`sspr( order, uplo, N, α, x, sx, AP )`][@stdlib/blas/base/sspr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = α*x*x^T + A`.</span>
110115
- <span class="signature">[`ssymv( order, uplo, N, α, A, LDA, x, sx, β, y, sy )`][@stdlib/blas/base/ssymv]</span><span class="delimiter">: </span><span class="description">perform the matrix-vector operation `y = α*A*x + β*y` where `α` and `β` are scalars, `x` and `y` are `N` element vectors, and `A` is an `N` by `N` symmetric matrix.</span>
111116
- <span class="signature">[`ssyr( order, uplo, N, α, x, sx, A, LDA )`][@stdlib/blas/base/ssyr]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 1 operation `A = α*x*x**T + A`.</span>
112117
- <span class="signature">[`ssyr2( order, uplo, N, α, x, sx, y, sy, A, LDA )`][@stdlib/blas/base/ssyr2]</span><span class="delimiter">: </span><span class="description">perform the symmetric rank 2 operation `A = α*x*y^T + α*y*x^T + A`.</span>
113118
- <span class="signature">[`strmv( order, uplo, trans, diag, N, A, LDA, x, sx )`][@stdlib/blas/base/strmv]</span><span class="delimiter">: </span><span class="description">perform one of the matrix-vector operations `x = A*x` or `x = A^T*x`.</span>
119+
- <span class="signature">[`strsv( order, uplo, trans, diag, N, A, LDA, x, sx )`][@stdlib/blas/base/strsv]</span><span class="delimiter">: </span><span class="description">solve one of the systems of equations `A*x = b` or `A^T*x = b`.</span>
114120

115121
</div>
116122

@@ -120,6 +126,13 @@ var o = blas;
120126

121127
<!-- <toc pattern="+(*gemm|*hemm|*symm|*herk|*syrk|*her2k|*syr2k|*trmm|*trsm)"> -->
122128

129+
<div class="namespace-toc">
130+
131+
- <span class="signature">[`dgemm( ord, ta, tb, M, N, K, α, A, lda, B, ldb, β, C, ldc )`][@stdlib/blas/base/dgemm]</span><span class="delimiter">: </span><span class="description">perform the matrix-matrix operation `C = α*op(A)*op(B) + β*C` where `op(X)` is one of the `op(X) = X`, or `op(X) = X^T`.</span>
132+
- <span class="signature">[`sgemm( ord, ta, tb, M, N, K, α, A, lda, B, ldb, β, C, ldc )`][@stdlib/blas/base/sgemm]</span><span class="delimiter">: </span><span class="description">perform the matrix-matrix operation `C = α*op(A)*op(B) + β*C` where `op(X)` is one of the `op(X) = X`, or `op(X) = X^T`.</span>
133+
134+
</div>
135+
123136
<!-- </toc> -->
124137

125138
### Scalar Operations
@@ -271,8 +284,16 @@ console.log( objectKeys( blas ) );
271284

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

287+
[@stdlib/blas/base/dgemm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dgemm
288+
289+
[@stdlib/blas/base/sgemm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sgemm
290+
291+
[@stdlib/blas/base/dgemv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dgemv
292+
274293
[@stdlib/blas/base/dspmv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dspmv
275294

295+
[@stdlib/blas/base/dspr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dspr
296+
276297
[@stdlib/blas/base/dsymv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dsymv
277298

278299
[@stdlib/blas/base/dsyr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dsyr
@@ -281,10 +302,14 @@ console.log( objectKeys( blas ) );
281302

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

305+
[@stdlib/blas/base/dtrsv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/dtrsv
306+
284307
[@stdlib/blas/base/sgemv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sgemv
285308

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

311+
[@stdlib/blas/base/sspr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/sspr
312+
288313
[@stdlib/blas/base/ssymv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ssymv
289314

290315
[@stdlib/blas/base/ssyr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ssyr
@@ -293,6 +318,8 @@ console.log( objectKeys( blas ) );
293318

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

321+
[@stdlib/blas/base/strsv]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/strsv
322+
296323
[@stdlib/blas/base/caxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/caxpy
297324

298325
[@stdlib/blas/base/ccopy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ccopy
@@ -377,6 +404,8 @@ console.log( objectKeys( blas ) );
377404

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

407+
[@stdlib/blas/base/zdscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zdscal
408+
380409
[@stdlib/blas/base/zscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zscal
381410

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

Diff for: lib/node_modules/@stdlib/blas/ext/base/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ var o = ns;
157157
- <span class="signature">[`ssumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/ssumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>
158158
- <span class="signature">[`ssumors( N, x, strideX )`][@stdlib/blas/ext/base/ssumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using ordinary recursive summation.</span>
159159
- <span class="signature">[`ssumpw( N, x, strideX )`][@stdlib/blas/ext/base/ssumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using pairwise summation.</span>
160+
- <span class="signature">[`wasm`][@stdlib/blas/ext/base/wasm]</span><span class="delimiter">: </span><span class="description">extensions to basic linear algebra subprograms (BLAS) compiled to WebAssembly.</span>
160161

161162
</div>
162163

@@ -435,6 +436,8 @@ console.log( objectKeys( ns ) );
435436

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

439+
[@stdlib/blas/ext/base/wasm]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/wasm
440+
438441
<!-- </toc-links> -->
439442

440443
</section>

Diff for: lib/node_modules/@stdlib/dstructs/README.md

+22
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ var o = ns;
4343

4444
<div class="namespace-toc">
4545

46+
- <span class="signature">[`CircularBuffer( buffer )`][@stdlib/dstructs/circular-buffer]</span><span class="delimiter">: </span><span class="description">circular buffer constructor.</span>
47+
- <span class="signature">[`CompactAdjacencyMatrix( N )`][@stdlib/dstructs/compact-adjacency-matrix]</span><span class="delimiter">: </span><span class="description">compact adjacency matrix constructor.</span>
48+
- <span class="signature">[`DoublyLinkedList()`][@stdlib/dstructs/doubly-linked-list]</span><span class="delimiter">: </span><span class="description">doubly linked list constructor.</span>
49+
- <span class="signature">[`FIFO()`][@stdlib/dstructs/fifo]</span><span class="delimiter">: </span><span class="description">first-in-first-out (FIFO) queue.</span>
50+
- <span class="signature">[`LinkedList()`][@stdlib/dstructs/linked-list]</span><span class="delimiter">: </span><span class="description">singly linked list.</span>
51+
- <span class="signature">[`namedtypedtuple( fields[, options] )`][@stdlib/dstructs/named-typed-tuple]</span><span class="delimiter">: </span><span class="description">create a factory for generating named typed tuples.</span>
52+
- <span class="signature">[`Stack()`][@stdlib/dstructs/stack]</span><span class="delimiter">: </span><span class="description">stack data structure.</span>
53+
4654
</div>
4755

4856
<!-- </toc> -->
@@ -84,6 +92,20 @@ console.log( objectKeys( ns ) );
8492

8593
<!-- <toc-links> -->
8694

95+
[@stdlib/dstructs/circular-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/circular-buffer
96+
97+
[@stdlib/dstructs/compact-adjacency-matrix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/compact-adjacency-matrix
98+
99+
[@stdlib/dstructs/doubly-linked-list]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/doubly-linked-list
100+
101+
[@stdlib/dstructs/fifo]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/fifo
102+
103+
[@stdlib/dstructs/linked-list]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/linked-list
104+
105+
[@stdlib/dstructs/named-typed-tuple]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/named-typed-tuple
106+
107+
[@stdlib/dstructs/stack]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/stack
108+
87109
<!-- </toc-links> -->
88110

89111
</section>

0 commit comments

Comments
 (0)