Skip to content

Commit bb0baff

Browse files
authored
docs: update namespace table of contents
PR-URL: #11322 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent f8be298 commit bb0baff

File tree

3 files changed

+18
-0
lines changed

3 files changed

+18
-0
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ var o = ns;
4444
<div class="namespace-toc">
4545

4646
- <span class="signature">[`cfill( N, alpha, x, strideX )`][@stdlib/blas/ext/base/cfill]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with a specified scalar constant.</span>
47+
- <span class="signature">[`cindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/cindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in a single-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
4748
- <span class="signature">[`csum( N, x, strideX )`][@stdlib/blas/ext/base/csum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements.</span>
4849
- <span class="signature">[`csumkbn( N, x, strideX )`][@stdlib/blas/ext/base/csumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision complex floating-point strided array elements using an improved Kahan–Babuška algorithm.</span>
4950
- <span class="signature">[`czeroTo( N, x, strideX )`][@stdlib/blas/ext/base/czero-to]</span><span class="delimiter">: </span><span class="description">fill a single-precision complex floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
@@ -138,6 +139,7 @@ var o = ns;
138139
- <span class="signature">[`gnansumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/gnansumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
139140
- <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>
140141
- <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>
142+
- <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>
141143
- <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>
142144
- <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>
143145
- <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>
@@ -199,6 +201,7 @@ var o = ns;
199201
- <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>
200202
- <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>
201203
- <span class="signature">[`zindexOfRow( order, M, N, A, LDA, x, strideX, workspace, strideW )`][@stdlib/blas/ext/base/zindex-of-row]</span><span class="delimiter">: </span><span class="description">return the index of the first row in a double-precision complex floating-point input matrix which has the same elements as a provided search vector.</span>
204+
- <span class="signature">[`zoneTo( N, x, strideX )`][@stdlib/blas/ext/base/zone-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 one.</span>
202205
- <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>
203206
- <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>
204207
- <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>
@@ -254,6 +257,8 @@ console.log( objectKeys( ns ) );
254257

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

260+
[@stdlib/blas/ext/base/cindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/cindex-of-row
261+
257262
[@stdlib/blas/ext/base/csum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/csum
258263

259264
[@stdlib/blas/ext/base/csumkbn]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/csumkbn
@@ -442,6 +447,8 @@ console.log( objectKeys( ns ) );
442447

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

450+
[@stdlib/blas/ext/base/gone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gone-to
451+
445452
[@stdlib/blas/ext/base/grev]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/grev
446453

447454
[@stdlib/blas/ext/base/gsort]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gsort
@@ -564,6 +571,8 @@ console.log( objectKeys( ns ) );
564571

565572
[@stdlib/blas/ext/base/zindex-of-row]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zindex-of-row
566573

574+
[@stdlib/blas/ext/base/zone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zone-to
575+
567576
[@stdlib/blas/ext/base/zsum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/zsum
568577

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

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ The namespace exposes the following APIs:
6262
- <span class="signature">[`dnansumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
6363
- <span class="signature">[`dnansumors( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using ordinary recursive summation.</span>
6464
- <span class="signature">[`dnansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/dnansumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values and using pairwise summation.</span>
65+
- <span class="signature">[`doneTo( arrays )`][@stdlib/blas/ext/base/ndarray/done-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 one.</span>
6566
- <span class="signature">[`dsorthp( arrays )`][@stdlib/blas/ext/base/ndarray/dsorthp]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray using heapsort.</span>
6667
- <span class="signature">[`dsortins( arrays )`][@stdlib/blas/ext/base/ndarray/dsortins]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray using insertion sort.</span>
6768
- <span class="signature">[`dsortsh( arrays )`][@stdlib/blas/ext/base/ndarray/dsortsh]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional double-precision floating-point ndarray using Shellsort.</span>
@@ -110,6 +111,7 @@ The namespace exposes the following APIs:
110111
- <span class="signature">[`snansumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/snansumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.</span>
111112
- <span class="signature">[`snansumors( arrays )`][@stdlib/blas/ext/base/ndarray/snansumors]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using ordinary recursive summation.</span>
112113
- <span class="signature">[`snansumpw( arrays )`][@stdlib/blas/ext/base/ndarray/snansumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of a one-dimensional single-precision floating-point ndarray, ignoring `NaN` values and using pairwise summation.</span>
114+
- <span class="signature">[`soneTo( arrays )`][@stdlib/blas/ext/base/ndarray/sone-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 one.</span>
113115
- <span class="signature">[`ssorthp( arrays )`][@stdlib/blas/ext/base/ndarray/ssorthp]</span><span class="delimiter">: </span><span class="description">sort a one-dimensional single-precision floating-point ndarray using heapsort.</span>
114116
- <span class="signature">[`ssum( arrays )`][@stdlib/blas/ext/base/ndarray/ssum]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray.</span>
115117
- <span class="signature">[`ssumkbn( arrays )`][@stdlib/blas/ext/base/ndarray/ssumkbn]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional single-precision floating-point ndarray using an improved Kahan–Babuška algorithm.</span>
@@ -196,6 +198,8 @@ console.log( objectKeys( ns ) );
196198

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

201+
[@stdlib/blas/ext/base/ndarray/done-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/done-to
202+
199203
[@stdlib/blas/ext/base/ndarray/dsorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsorthp
200204

201205
[@stdlib/blas/ext/base/ndarray/dsortins]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/dsortins
@@ -292,6 +296,8 @@ console.log( objectKeys( ns ) );
292296

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

299+
[@stdlib/blas/ext/base/ndarray/sone-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/sone-to
300+
295301
[@stdlib/blas/ext/base/ndarray/ssorthp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/ssorthp
296302

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,7 @@ In addition, the namespace contains the following multidimensional array utility
165165
- <span class="signature">[`ndarray2localeString( x[, locales[, options]] )`][@stdlib/ndarray/to-locale-string]</span><span class="delimiter">: </span><span class="description">serialize an ndarray as a locale-aware string.</span>
166166
- <span class="signature">[`toReversedDimension( x[, options] )`][@stdlib/ndarray/to-reversed-dimension]</span><span class="delimiter">: </span><span class="description">return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed.</span>
167167
- <span class="signature">[`toReversed( x )`][@stdlib/ndarray/to-reversed]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension.</span>
168+
- <span class="signature">[`ndarray2string( x )`][@stdlib/ndarray/to-string]</span><span class="delimiter">: </span><span class="description">serialize an ndarray as a string.</span>
168169
- <span class="signature">[`unshift( x, ...values )`][@stdlib/ndarray/unshift]</span><span class="delimiter">: </span><span class="description">return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.</span>
169170
- <span class="signature">[`vector`][@stdlib/ndarray/vector]</span><span class="delimiter">: </span><span class="description">vector constructors and associated utilities.</span>
170171
- <span class="signature">[`ndarrayWith( x, indices, value )`][@stdlib/ndarray/with]</span><span class="delimiter">: </span><span class="description">return a new ndarray with the element at a specified index replaced by a provided value.</span>
@@ -400,6 +401,8 @@ console.log( objectKeys( ns ) );
400401

401402
[@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed
402403

404+
[@stdlib/ndarray/to-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-string
405+
403406
[@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift
404407

405408
[@stdlib/ndarray/vector]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector

0 commit comments

Comments
 (0)