Skip to content

Commit d6b1e3d

Browse files
authored
docs: update namespace table of contents
PR-URL: #11809 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent e1b8e98 commit d6b1e3d

5 files changed

Lines changed: 36 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
@@ -60,6 +60,7 @@ The namespace contains the following:
6060
- <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>
6161
- <span class="signature">[`toSorted( x[, sortOrder][, options] )`][@stdlib/blas/ext/to-sorted]</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.</span>
6262
- <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>
63+
- <span class="signature">[`unitspace( shape, start[, options] )`][@stdlib/blas/ext/unitspace]</span><span class="delimiter">: </span><span class="description">return a new ndarray filled with linearly spaced numeric elements which increment by `1` starting from a specified value along one or more ndarray dimensions.</span>
6364
- <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>
6465

6566
</div>
@@ -133,6 +134,8 @@ console.log( objectKeys( ns ) );
133134

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

137+
[@stdlib/blas/ext/unitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/unitspace
138+
136139
[@stdlib/blas/ext/zero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/zero-to
137140

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

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ var o = ns;
5757
- <span class="signature">[`dapxsumors( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumors]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum using ordinary recursive summation.</span>
5858
- <span class="signature">[`dapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/dapxsumpw]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each double-precision floating-point strided array element and compute the sum using pairwise summation.</span>
5959
- <span class="signature">[`dasumpw( N, x, strideX )`][@stdlib/blas/ext/base/dasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of double-precision floating-point strided array elements using pairwise summation.</span>
60+
- <span class="signature">[`dcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/dcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a double-precision floating-point strided array.</span>
6061
- <span class="signature">[`dcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/dcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a double-precision floating-point strided array by a specified number of positions.</span>
6162
- <span class="signature">[`dcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusum]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of double-precision floating-point strided array elements.</span>
6263
- <span class="signature">[`dcusumkbn( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumkbn]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
@@ -127,6 +128,7 @@ var o = ns;
127128
- <span class="signature">[`gcusumkbn2( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>
128129
- <span class="signature">[`gcusumors( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusumors]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements using ordinary recursive summation.</span>
129130
- <span class="signature">[`gcusumpw( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusumpw]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements using pairwise summation.</span>
131+
- <span class="signature">[`gdiff( N, k, x, strideX, N1, prepend, strideP, N2, append, strideA, out, strideOut, workspace, strideW )`][@stdlib/blas/ext/base/gdiff]</span><span class="delimiter">: </span><span class="description">calculate the k-th discrete forward difference of a strided array.</span>
130132
- <span class="signature">[`gfillBy( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfill-by]</span><span class="delimiter">: </span><span class="description">fill a strided array according to a provided callback function.</span>
131133
- <span class="signature">[`gfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gfill]</span><span class="delimiter">: </span><span class="description">fill a strided array with a specified scalar constant.</span>
132134
- <span class="signature">[`gfindIndex( N, x, strideX, clbk[, thisArg] )`][@stdlib/blas/ext/base/gfind-index]</span><span class="delimiter">: </span><span class="description">return the index of the first element which passes a test implemented by a predicate function.</span>
@@ -213,6 +215,7 @@ var o = ns;
213215
- <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>
214216
- <span class="signature">[`sunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/sunitspace]</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 a specified value.</span>
215217
- <span class="signature">[`svander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/svander]</span><span class="delimiter">: </span><span class="description">generate a single-precision floating-point Vandermonde matrix.</span>
218+
- <span class="signature">[`swhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/swhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two single-precision floating-point strided arrays depending on a condition.</span>
216219
- <span class="signature">[`szeroTo( N, x, strideX )`][@stdlib/blas/ext/base/szero-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 zero.</span>
217220
- <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>
218221
- <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>
@@ -301,6 +304,8 @@ console.log( objectKeys( ns ) );
301304

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

307+
[@stdlib/blas/ext/base/dcartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dcartesian-square
308+
304309
[@stdlib/blas/ext/base/dcircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dcircshift
305310

306311
[@stdlib/blas/ext/base/dcusum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dcusum
@@ -441,6 +446,8 @@ console.log( objectKeys( ns ) );
441446

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

449+
[@stdlib/blas/ext/base/gdiff]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gdiff
450+
444451
[@stdlib/blas/ext/base/gfill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill-by
445452

446453
[@stdlib/blas/ext/base/gfill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gfill
@@ -613,6 +620,8 @@ console.log( objectKeys( ns ) );
613620

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

623+
[@stdlib/blas/ext/base/swhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/swhere
624+
616625
[@stdlib/blas/ext/base/szero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/szero-to
617626

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

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ The namespace exposes the following APIs:
4848
- <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>
4949
- <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>
5050
- <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>
51+
- <span class="signature">[`cunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/cunitspace]</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 a specified value.</span>
5152
- <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>
5253
- <span class="signature">[`dcircshift( arrays )`][@stdlib/blas/ext/base/ndarray/dcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a one-dimensional double-precision floating-point ndarray by a specified number of positions.</span>
5354
- <span class="signature">[`dcusum( arrays )`][@stdlib/blas/ext/base/ndarray/dcusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional double-precision floating-point ndarray.</span>
@@ -73,6 +74,7 @@ The namespace exposes the following APIs:
7374
- <span class="signature">[`dsumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dsumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional double-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
7475
- <span class="signature">[`dsumors( arrays )`][@stdlib/blas/ext/base/ndarray/dsumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray using ordinary recursive summation.</span>
7576
- <span class="signature">[`dsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dsumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray using pairwise summation.</span>
77+
- <span class="signature">[`dunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/dunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
7678
- <span class="signature">[`dzeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/dzero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional double-precision floating-point ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
7779
- <span class="signature">[`gcircshift( arrays )`][@stdlib/blas/ext/base/ndarray/gcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a one-dimensional ndarray by a specified number of positions.</span>
7880
- <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>
@@ -123,10 +125,12 @@ The namespace exposes the following APIs:
123125
- <span class="signature">[`ssumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/ssumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
124126
- <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>
125127
- <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>
128+
- <span class="signature">[`sunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/sunitspace]</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 a specified value.</span>
126129
- <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>
127130
- <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>
128131
- <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>
129132
- <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>
133+
- <span class="signature">[`zunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/zunitspace]</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 a specified value.</span>
130134
- <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>
131135

132136
</div>
@@ -176,6 +180,8 @@ console.log( objectKeys( ns ) );
176180

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

183+
[@stdlib/blas/ext/base/ndarray/cunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/cunitspace
184+
179185
[@stdlib/blas/ext/base/ndarray/czero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/czero-to
180186

181187
[@stdlib/blas/ext/base/ndarray/dcircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dcircshift
@@ -226,6 +232,8 @@ console.log( objectKeys( ns ) );
226232

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

235+
[@stdlib/blas/ext/base/ndarray/dunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dunitspace
236+
229237
[@stdlib/blas/ext/base/ndarray/dzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dzero-to
230238

231239
[@stdlib/blas/ext/base/ndarray/gcircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gcircshift
@@ -326,6 +334,8 @@ console.log( objectKeys( ns ) );
326334

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

337+
[@stdlib/blas/ext/base/ndarray/sunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sunitspace
338+
329339
[@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
330340

331341
[@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
@@ -334,6 +344,8 @@ console.log( objectKeys( ns ) );
334344

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

347+
[@stdlib/blas/ext/base/ndarray/zunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zunitspace
348+
337349
[@stdlib/blas/ext/base/ndarray/zzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/zzero-to
338350

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

0 commit comments

Comments
 (0)