Skip to content

docs: update namespace table of contents #14160

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.

Sign up for GitHub

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

Open
stdlib-bot wants to merge 1 commit into
base: develop
Choose a base branch
from
+9 −0
Open

docs: update namespace table of contents #14160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/base/ndarray/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`dcusumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dcusumpw]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional double-precision floating-point ndarray using pairwise summation.</span>
- <span class="signature">[`ddiff( arrays )`][@stdlib/blas/ext/base/ndarray/ddiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-nan]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`dfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/dfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional double-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`dfirstIndexGreaterThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional double-precision floating-point ndarray which is greater than a corresponding element in another one-dimensional double-precision floating-point ndarray.</span>
- <span class="signature">[`dfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/dfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional double-precision floating-point ndarray which is less than a corresponding element in another one-dimensional double-precision floating-point ndarray.</span>
Expand Down Expand Up @@ -117,6 +118,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`gcusumors( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumors]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using ordinary recursive summation.</span>
- <span class="signature">[`gcusumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumpw]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using pairwise summation.</span>
- <span class="signature">[`gfillEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-nan]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`gfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`gfindIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function.</span>
- <span class="signature">[`gfindLastIndex( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a one-dimensional ndarray which passes a test implemented by a predicate function.</span>
Expand Down Expand Up @@ -163,6 +165,7 @@ The namespace exposes the following APIs:
- <span class="signature">[`scusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
- <span class="signature">[`scusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/scusumkbn2]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
- <span class="signature">[`scusumors( arrays )`][@stdlib/blas/ext/base/ndarray/scusumors]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation.</span>
- <span class="signature">[`sfillNaN( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-nan]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision floating-point ndarray equal to `NaN` with a specified scalar constant.</span>
- <span class="signature">[`sfillNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sfill-not-equal]</span><span class="delimiter">: </span><span class="description">replace elements in a one-dimensional single-precision floating-point ndarray not equal to a provided search element with a specified scalar constant.</span>
- <span class="signature">[`sfirstIndexLessThan( arrays )`][@stdlib/blas/ext/base/ndarray/sfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional single-precision floating-point ndarray which is less than a corresponding element in another one-dimensional single-precision floating-point ndarray.</span>
- <span class="signature">[`sindexOfNotEqual( arrays )`][@stdlib/blas/ext/base/ndarray/sindex-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a one-dimensional single-precision floating-point ndarray which is not equal to a specified search element.</span>
Expand Down Expand Up @@ -304,6 +307,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/ndarray/dfirst-index-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dfirst-index-greater-than
Expand Down Expand Up @@ -394,6 +399,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/ndarray/gfind-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfind-index
Expand Down Expand Up @@ -486,6 +493,8 @@ console.log( objectKeys( ns ) );

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

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

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

[@stdlib/blas/ext/base/ndarray/sfirst-index-less-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sfirst-index-less-than
Expand Down