Skip to content

docs: update namespace table of contents #5366

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.

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
merged 2 commits into from
Feb 22, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/_tools/eslint/rules/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ var eslint = rules;
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
Expand Down Expand Up @@ -240,6 +241,8 @@ console.log( getKeys( rules ) );

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

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

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

[@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
Expand Down
29 changes: 29 additions & 0 deletions lib/node_modules/@stdlib/blas/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ var o = blas;
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>

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

<div class="namespace-toc">

- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>

</div>

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

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

<div class="namespace-toc">

- <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>
- <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>

</div>

<!-- </toc> -->

### Scalar Operations
Expand Down Expand Up @@ -271,8 +284,16 @@ console.log( objectKeys( blas ) );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[@stdlib/blas/base/zswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/zswap
Expand Down
3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ var o = ns;
- <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>
- <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>
- <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>
- <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>

</div>

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

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

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

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

</section>
Expand Down
22 changes: 22 additions & 0 deletions lib/node_modules/@stdlib/dstructs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@ var o = ns;

<div class="namespace-toc">

- <span class="signature">[`CircularBuffer( buffer )`][@stdlib/dstructs/circular-buffer]</span><span class="delimiter">: </span><span class="description">circular buffer constructor.</span>
- <span class="signature">[`CompactAdjacencyMatrix( N )`][@stdlib/dstructs/compact-adjacency-matrix]</span><span class="delimiter">: </span><span class="description">compact adjacency matrix constructor.</span>
- <span class="signature">[`DoublyLinkedList()`][@stdlib/dstructs/doubly-linked-list]</span><span class="delimiter">: </span><span class="description">doubly linked list constructor.</span>
- <span class="signature">[`FIFO()`][@stdlib/dstructs/fifo]</span><span class="delimiter">: </span><span class="description">first-in-first-out (FIFO) queue.</span>
- <span class="signature">[`LinkedList()`][@stdlib/dstructs/linked-list]</span><span class="delimiter">: </span><span class="description">singly linked list.</span>
- <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>
- <span class="signature">[`Stack()`][@stdlib/dstructs/stack]</span><span class="delimiter">: </span><span class="description">stack data structure.</span>

</div>

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

<!-- <toc-links> -->

[@stdlib/dstructs/circular-buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/circular-buffer

[@stdlib/dstructs/compact-adjacency-matrix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/compact-adjacency-matrix

[@stdlib/dstructs/doubly-linked-list]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/doubly-linked-list

[@stdlib/dstructs/fifo]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/fifo

[@stdlib/dstructs/linked-list]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/linked-list

[@stdlib/dstructs/named-typed-tuple]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/named-typed-tuple

[@stdlib/dstructs/stack]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/dstructs/stack

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

</section>
Expand Down
Loading
Loading