Skip to content

Commit 6dc0130

Browse files
authored
docs: update namespace table of contents
PR-URL: #11350 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 69e1068 commit 6dc0130

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ The namespace contains the following:
5757
- <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>
5858
- <span class="signature">[`sum( x[, options] )`][@stdlib/blas/ext/sum]</span><span class="delimiter">: </span><span class="description">compute the sum along one or more ndarray dimensions.</span>
5959
- <span class="signature">[`toSortedhp( x[, sortOrder][, options] )`][@stdlib/blas/ext/to-sortedhp]</span><span class="delimiter">: </span><span class="description">return a new ndarray containing the elements of an input ndarray sorted along one or more ndarray dimensions using heapsort.</span>
60+
- <span class="signature">[`zeroTo( shape[, options] )`][@stdlib/blas/ext/zero-to]</span><span class="delimiter">: </span><span class="description">return a new ndarray filled with linearly spaced numeric elements which increment by `1` starting from zero along one or more ndarray dimensions.</span>
6061

6162
</div>
6263

@@ -123,6 +124,8 @@ console.log( objectKeys( ns ) );
123124

124125
[@stdlib/blas/ext/to-sortedhp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/to-sortedhp
125126

127+
[@stdlib/blas/ext/zero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/zero-to
128+
126129
<!-- </toc-links> -->
127130

128131
</section>

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ var o = ns;
141141
- <span class="signature">[`gnansumors( N, x, strideX )`][@stdlib/blas/ext/base/gnansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using ordinary recursive summation.</span>
142142
- <span class="signature">[`gnansumpw( N, x, strideX )`][@stdlib/blas/ext/base/gnansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using pairwise summation.</span>
143143
- <span class="signature">[`goneTo( N, x, strideX )`][@stdlib/blas/ext/base/gone-to]</span><span class="delimiter">: </span><span class="description">fill a strided array with linearly spaced numeric elements which increment by `1` starting from one.</span>
144+
- <span class="signature">[`greplicate( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/greplicate]</span><span class="delimiter">: </span><span class="description">replicate each strided array element a specified number of times.</span>
144145
- <span class="signature">[`grev( N, x, strideX )`][@stdlib/blas/ext/base/grev]</span><span class="delimiter">: </span><span class="description">reverse a strided array in-place.</span>
145146
- <span class="signature">[`gsort( N, order, x, strideX )`][@stdlib/blas/ext/base/gsort]</span><span class="delimiter">: </span><span class="description">sort a strided array.</span>
146147
- <span class="signature">[`gsort2hp( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2hp]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using heapsort.</span>
@@ -452,6 +453,8 @@ console.log( objectKeys( ns ) );
452453

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

456+
[@stdlib/blas/ext/base/greplicate]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/greplicate
457+
455458
[@stdlib/blas/ext/base/grev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/grev
456459

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

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

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

4646
<div class="namespace-toc">
4747

48+
- <span class="signature">[`coneTo( arrays )`][@stdlib/blas/ext/base/ndarray/cone-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
4849
- <span class="signature">[`csum( arrays )`][@stdlib/blas/ext/base/ndarray/csum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray.</span>
4950
- <span class="signature">[`csumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/csumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
5051
- <span class="signature">[`czeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/czero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
@@ -120,6 +121,7 @@ The namespace exposes the following APIs:
120121
- <span class="signature">[`ssumors( arrays )`][@stdlib/blas/ext/base/ndarray/ssumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray using ordinary recursive summation.</span>
121122
- <span class="signature">[`ssumpw( arrays )`][@stdlib/blas/ext/base/ndarray/ssumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using pairwise summation.</span>
122123
- <span class="signature">[`szeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/szero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional single-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
124+
- <span class="signature">[`zoneTo( arrays )`][@stdlib/blas/ext/base/ndarray/zone-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from one.</span>
123125
- <span class="signature">[`zsum( arrays )`][@stdlib/blas/ext/base/ndarray/zsum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray.</span>
124126
- <span class="signature">[`zsumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/zsumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision complex floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
125127
- <span class="signature">[`zzeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/zzero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision complex floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
@@ -165,6 +167,8 @@ console.log( objectKeys( ns ) );
165167

166168
<!-- <toc-links> -->
167169

170+
[@stdlib/blas/ext/base/ndarray/cone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cone-to
171+
168172
[@stdlib/blas/ext/base/ndarray/csum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/csum
169173

170174
[@stdlib/blas/ext/base/ndarray/csumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/csumkbn
@@ -315,6 +319,8 @@ console.log( objectKeys( ns ) );
315319

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

322+
[@stdlib/blas/ext/base/ndarray/zone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zone-to
323+
318324
[@stdlib/blas/ext/base/ndarray/zsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zsum
319325

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

0 commit comments

Comments
 (0)