Skip to content

Commit 6ea70f1

Browse files
Planeshifterstdlib-bot
authored andcommitted
docs: update namespace table of contents
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 5ea3825 commit 6ea70f1

File tree

4 files changed

+27
-0
lines changed

4 files changed

+27
-0
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The namespace exposes the following APIs:
4747

4848
- <span class="signature">[`dasum( arrays )`][@stdlib/blas/base/ndarray/dasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.</span>
4949
- <span class="signature">[`ddot( arrays )`][@stdlib/blas/base/ndarray/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional double-precision floating-point ndarrays.</span>
50+
- <span class="signature">[`gasum( arrays )`][@stdlib/blas/base/ndarray/gasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional ndarray.</span>
5051
- <span class="signature">[`gdot( arrays )`][@stdlib/blas/base/ndarray/gdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional ndarrays.</span>
5152
- <span class="signature">[`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.</span>
5253
- <span class="signature">[`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays.</span>
@@ -96,6 +97,8 @@ console.log( objectKeys( ns ) );
9697

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

100+
[@stdlib/blas/base/ndarray/gasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gasum
101+
99102
[@stdlib/blas/base/ndarray/gdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/gdot
100103

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

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,12 @@ The namespace contains the following:
4646
<div class="namespace-toc">
4747

4848
- <span class="signature">[`base`][@stdlib/blas/ext/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) extensions to basic linear algebra subprograms (BLAS).</span>
49+
- <span class="signature">[`circshift( x, k[, options] )`][@stdlib/blas/ext/circshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of an input ndarray by a specified number of positions along one or more ndarray dimensions.</span>
4950
- <span class="signature">[`cusum( x[, initial][, options] )`][@stdlib/blas/ext/cusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum along one or more ndarray dimensions.</span>
5051
- <span class="signature">[`findIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element along an ndarray dimension which passes a test implemented by a predicate function.</span>
5152
- <span class="signature">[`findLastIndex( x[, options], clbk[, thisArg] )`][@stdlib/blas/ext/find-last-index]</span><span class="delimiter">: </span><span class="description">return the index of the last element along an ndarray dimension which passes a test implemented by a predicate function.</span>
5253
- <span class="signature">[`indexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/index-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element along an ndarray dimension.</span>
54+
- <span class="signature">[`join( x[, options] )`][@stdlib/blas/ext/join]</span><span class="delimiter">: </span><span class="description">return an ndarray created by joining elements using a separator along one or more ndarray dimensions.</span>
5355
- <span class="signature">[`lastIndexOf( x, searchElement[, fromIndex][, options] )`][@stdlib/blas/ext/last-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element along an ndarray dimension.</span>
5456
- <span class="signature">[`linspace( shape, start, stop[, endpoint][, options] )`][@stdlib/blas/ext/linspace]</span><span class="delimiter">: </span><span class="description">return a new ndarray filled with linearly spaced values over a specified interval along one or more ndarray dimensions.</span>
5557
- <span class="signature">[`sorthp( x[, sortOrder][, options] )`][@stdlib/blas/ext/sorthp]</span><span class="delimiter">: </span><span class="description">sort an input ndarray along one or more ndarray dimensions using heapsort.</span>
@@ -99,6 +101,8 @@ console.log( objectKeys( ns ) );
99101

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

104+
[@stdlib/blas/ext/circshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/circshift
105+
102106
[@stdlib/blas/ext/cusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cusum
103107

104108
[@stdlib/blas/ext/find-index]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/find-index
@@ -107,6 +111,8 @@ console.log( objectKeys( ns ) );
107111

108112
[@stdlib/blas/ext/index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/index-of
109113

114+
[@stdlib/blas/ext/join]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/join
115+
110116
[@stdlib/blas/ext/last-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/last-index-of
111117

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

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,7 @@ var o = ns;
172172
- <span class="signature">[`sdssum( N, x, strideX )`][@stdlib/blas/ext/base/sdssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation.</span>
173173
- <span class="signature">[`sdssumpw( N, x, strideX )`][@stdlib/blas/ext/base/sdssumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using pairwise summation with extended accumulation.</span>
174174
- <span class="signature">[`sfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/sfill]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with a specified scalar constant.</span>
175+
- <span class="signature">[`sindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/sindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in a single-precision floating-point input matrix which has the same elements as a provided search vector.</span>
175176
- <span class="signature">[`sindexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/sindex-of]</span><span class="delimiter">: </span><span class="description">return the first index of a specified search element in a single-precision floating-point strided array.</span>
176177
- <span class="signature">[`slastIndexOf( N, searchElement, x, strideX )`][@stdlib/blas/ext/base/slast-index-of]</span><span class="delimiter">: </span><span class="description">return the last index of a specified search element in a single-precision floating-point strided array.</span>
177178
- <span class="signature">[`slinspace( N, start, stop, endpoint, x, strideX )`][@stdlib/blas/ext/base/slinspace]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced values over a specified interval.</span>
@@ -180,6 +181,7 @@ var o = ns;
180181
- <span class="signature">[`snansumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/snansumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
181182
- <span class="signature">[`snansumors( N, x, strideX )`][@stdlib/blas/ext/base/snansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
182183
- <span class="signature">[`snansumpw( N, x, strideX )`][@stdlib/blas/ext/base/snansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.</span>
184+
- <span class="signature">[`soneTo( N, x, strideX )`][@stdlib/blas/ext/base/sone-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
183185
- <span class="signature">[`srev( N, x, strideX )`][@stdlib/blas/ext/base/srev]</span><span class="delimiter">: </span><span class="description">reverse a single-precision floating-point strided array in-place.</span>
184186
- <span class="signature">[`ssort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using heapsort.</span>
185187
- <span class="signature">[`ssort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/ssort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two single-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>
@@ -197,6 +199,7 @@ var o = ns;
197199
- <span class="signature">[`zfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/zfill]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with a specified scalar constant.</span>
198200
- <span class="signature">[`zsum( N, x, strideX )`][@stdlib/blas/ext/base/zsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements.</span>
199201
- <span class="signature">[`zsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/zsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
202+
- <span class="signature">[`zzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/zzero-to]</span><span class="delimiter">: </span><span class="description">fill a double-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
200203

201204
</div>
202205

@@ -505,6 +508,8 @@ console.log( objectKeys( ns ) );
505508

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

511+
[@stdlib/blas/ext/base/sindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of-row
512+
508513
[@stdlib/blas/ext/base/sindex-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sindex-of
509514

510515
[@stdlib/blas/ext/base/slast-index-of]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/slast-index-of
@@ -521,6 +526,8 @@ console.log( objectKeys( ns ) );
521526

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

529+
[@stdlib/blas/ext/base/sone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/sone-to
530+
524531
[@stdlib/blas/ext/base/srev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/srev
525532

526533
[@stdlib/blas/ext/base/ssort2hp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssort2hp
@@ -555,6 +562,8 @@ console.log( objectKeys( ns ) );
555562

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

565+
[@stdlib/blas/ext/base/zzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zzero-to
566+
558567
<!-- </toc-links> -->
559568

560569
</section>

0 commit comments

Comments
 (0)