Skip to content

Commit 19c183e

Browse files
authored
docs: update namespace table of contents
PR-URL: #15675 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 5f54fc0 commit 19c183e

2 files changed

Lines changed: 15 additions & 6 deletions

File tree

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -241,18 +241,19 @@ var o = ns;
241241
- <span class="signature">[`gfirstIndexGreaterThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is greater than a corresponding element in another strided array.</span>
242242
- <span class="signature">[`gfirstIndexLessThanEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is less than or equal to a corresponding element in another strided array.</span>
243243
- <span class="signature">[`gfirstIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is less than a corresponding element in another strided array.</span>
244-
- <span class="signature">[`gfirstIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is not equal to the corresponding element in another strided array.</span>
245-
- <span class="signature">[`gindexOfAlmostSameValue( N, searchElement, maxULP, x, strideX )`][@stdlib/blas/ext/base/gindex-of-almost-same-value]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is almost the same value as a provided search element.</span>
244+
- <span class="signature">[`gfirstIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gfirst-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is not equal to a corresponding element in another strided array.</span>
245+
- <span class="signature">[`gindexOfAlmostSameValue( N, searchElement, maxULP, x, strideX )`][@stdlib/blas/ext/base/gindex-of-almost-same-value]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is almost the same value as a specified search element.</span>
246246
- <span class="signature">[`gindexOfColumn( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-column]</span><span class="delimiter">: </span><span class="description">return the index of the first column in an input matrix which has the same elements as a provided search vector.</span>
247247
- <span class="signature">[`gindexOfFalsyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-falsy-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix in which all elements are falsy.</span>
248248
- <span class="signature">[`gindexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the first falsy element in a strided array.</span>
249-
- <span class="signature">[`gindexOfGreaterThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is greater than or equal to a specified search element.</span>
250-
- <span class="signature">[`gindexOfGreaterThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which is greater than a specified search element.</span>
249+
- <span class="signature">[`gindexOfGreaterThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is greater than or equal to a specified search element.</span>
250+
- <span class="signature">[`gindexOfGreaterThanSorted( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than-sorted]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a sorted strided array which is greater than a specified search element.</span>
251+
- <span class="signature">[`gindexOfGreaterThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-greater-than]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is greater than a specified search element.</span>
251252
- <span class="signature">[`gindexOfLessThanEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is less than or equal to a specified search element.</span>
252253
- <span class="signature">[`gindexOfLessThan( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-less-than]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is less than a specified search element.</span>
253254
- <span class="signature">[`gindexOfNotEqual( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-not-equal]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which is not equal to a specified search element.</span>
254255
- <span class="signature">[`gindexOfRow( order, M, N, A, LDA, x, strideX )`][@stdlib/blas/ext/base/gindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix which has the same elements as a provided search vector.</span>
255-
- <span class="signature">[`gindexOfSameValue( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-same-value]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a strided array which has the same value as a provided search element.</span>
256+
- <span class="signature">[`gindexOfSameValue( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of-same-value]</span><span class="delimiter">: </span><span class="description">return the first index of an element in a strided array which has the same value as a specified search element.</span>
256257
- <span class="signature">[`gindexOfTruthyRow( order, M, N, A, LDA )`][@stdlib/blas/ext/base/gindex-of-truthy-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in an input matrix which contains at least one truthy element.</span>
257258
- <span class="signature">[`gindexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/gindex-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the first truthy element in a strided array.</span>
258259
- <span class="signature">[`gindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/gindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a strided array.</span>
@@ -264,7 +265,7 @@ var o = ns;
264265
- <span class="signature">[`glastIndexGreaterThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-greater-than]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is greater than a corresponding element in another strided array.</span>
265266
- <span class="signature">[`glastIndexLessThanEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-less-than-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is less than or equal to a corresponding element in another strided array.</span>
266267
- <span class="signature">[`glastIndexLessThan( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-less-than]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is less than a corresponding element in another strided array.</span>
267-
- <span class="signature">[`glastIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is not equal to the corresponding element in another strided array.</span>
268+
- <span class="signature">[`glastIndexNotEqual( N, x, strideX, y, strideY )`][@stdlib/blas/ext/base/glast-index-not-equal]</span><span class="delimiter">: </span><span class="description">return the index of the last element in a strided array which is not equal to a corresponding element in another strided array.</span>
268269
- <span class="signature">[`glastIndexOfFalsy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-falsy]</span><span class="delimiter">: </span><span class="description">return the index of the last falsy element in a strided array.</span>
269270
- <span class="signature">[`glastIndexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/glast-index-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the last row in an input matrix which has the same elements as a provided search vector.</span>
270271
- <span class="signature">[`glastIndexOfTruthy( N, x, strideX )`][@stdlib/blas/ext/base/glast-index-of-truthy]</span><span class="delimiter">: </span><span class="description">return the index of the last truthy element in a strided array.</span>
@@ -924,6 +925,8 @@ console.log( objectKeys( ns ) );
924925

925926
[@stdlib/blas/ext/base/gindex-of-greater-than-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-greater-than-equal
926927

928+
[@stdlib/blas/ext/base/gindex-of-greater-than-sorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-greater-than-sorted
929+
927930
[@stdlib/blas/ext/base/gindex-of-greater-than]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-greater-than
928931

929932
[@stdlib/blas/ext/base/gindex-of-less-than-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gindex-of-less-than-equal

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,7 @@ The namespace exposes the following APIs:
142142
- <span class="signature">[`gcuany( arrays )`][@stdlib/blas/ext/base/ndarray/gcuany]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least one element in a one-dimensional ndarray is truthy.</span>
143143
- <span class="signature">[`gcuevery( arrays )`][@stdlib/blas/ext/base/ndarray/gcuevery]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a one-dimensional ndarray is truthy.</span>
144144
- <span class="signature">[`gcunone( arrays )`][@stdlib/blas/ext/base/ndarray/gcunone]</span><span class="delimiter">: </span><span class="description">cumulatively test whether every element in a one-dimensional ndarray is falsy.</span>
145+
- <span class="signature">[`gcusome( arrays )`][@stdlib/blas/ext/base/ndarray/gcusome]</span><span class="delimiter">: </span><span class="description">cumulatively test whether at least `k` elements in a one-dimensional ndarray are truthy.</span>
145146
- <span class="signature">[`gcusum( arrays )`][@stdlib/blas/ext/base/ndarray/gcusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray.</span>
146147
- <span class="signature">[`gcusumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumkbn]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using an improved Kahan–Babuška algorithm.</span>
147148
- <span class="signature">[`gcusumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/gcusumkbn2]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
@@ -156,6 +157,7 @@ The namespace exposes the following APIs:
156157
- <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>
157158
- <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>
158159
- <span class="signature">[`gfill( arrays )`][@stdlib/blas/ext/base/ndarray/gfill]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with a specified scalar constant.</span>
160+
- <span class="signature">[`gfindIndexBetween( arrays, clbk[, thisArg] )`][@stdlib/blas/ext/base/ndarray/gfind-index-between]</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 within a specified range.</span>
159161
- <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>
160162
- <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>
161163
- <span class="signature">[`gfirstIndexEqual( arrays )`][@stdlib/blas/ext/base/ndarray/gfirst-index-equal]</span><span class="delimiter">: </span><span class="description">return the index of the first element in a one-dimensional ndarray equal to a corresponding element in another one-dimensional ndarray.</span>
@@ -526,6 +528,8 @@ console.log( objectKeys( ns ) );
526528

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

531+
[@stdlib/blas/ext/base/ndarray/gcusome]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusome
532+
529533
[@stdlib/blas/ext/base/ndarray/gcusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusum
530534

531535
[@stdlib/blas/ext/base/ndarray/gcusumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcusumkbn
@@ -554,6 +558,8 @@ console.log( objectKeys( ns ) );
554558

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

561+
[@stdlib/blas/ext/base/ndarray/gfind-index-between]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gfind-index-between
562+
557563
[@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
558564

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

0 commit comments

Comments
 (0)