Skip to content

Commit 11fb87d

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

5 files changed

Lines changed: 22 additions & 1 deletion

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ The namespace exposes the following APIs:
6969
- <span class="signature">[`sswap( arrays )`][@stdlib/blas/base/ndarray/sswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional single-precision floating-point ndarrays.</span>
7070
- <span class="signature">[`zaxpy( arrays )`][@stdlib/blas/base/ndarray/zaxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision complex floating-point ndarray `y`.</span>
7171
- <span class="signature">[`zcopy( arrays )`][@stdlib/blas/base/ndarray/zcopy]</span><span class="delimiter">: </span><span class="description">copy values from a one-dimensional double-precision complex floating-point ndarray `x` into a one-dimensional double-precision complex floating-point ndarray `y`.</span>
72+
- <span class="signature">[`zscal( arrays )`][@stdlib/blas/base/ndarray/zscal]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision complex floating-point ndarray by a scalar constant.</span>
7273
- <span class="signature">[`zswap( arrays )`][@stdlib/blas/base/ndarray/zswap]</span><span class="delimiter">: </span><span class="description">interchange two one-dimensional double-precision complex floating-point ndarrays.</span>
7374

7475
</div>
@@ -160,6 +161,8 @@ console.log( objectKeys( ns ) );
160161

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

164+
[@stdlib/blas/base/ndarray/zscal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zscal
165+
163166
[@stdlib/blas/base/ndarray/zswap]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zswap
164167

165168
<!-- </toc-links> -->

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ var o = ns;
114114
- <span class="signature">[`dsumpw( N, x, strideX )`][@stdlib/blas/ext/base/dsumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements using pairwise summation.</span>
115115
- <span class="signature">[`dunitspace( N, start, x, strideX )`][@stdlib/blas/ext/base/dunitspace]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
116116
- <span class="signature">[`dvander( order, mode, M, N, x, strideX, out, ldo )`][@stdlib/blas/ext/base/dvander]</span><span class="delimiter">: </span><span class="description">generate a double-precision floating-point Vandermonde matrix.</span>
117+
- <span class="signature">[`dwhere( N, condition, strideC, x, strideX, y, strideY, out, strideOut )`][@stdlib/blas/ext/base/dwhere]</span><span class="delimiter">: </span><span class="description">take elements from one of two double-precision floating-point strided arrays depending on a condition.</span>
117118
- <span class="signature">[`dzeroTo( N, x, strideX )`][@stdlib/blas/ext/base/dzero-to]</span><span class="delimiter">: </span><span class="description">fill a double-precision floating-point strided array with linearly spaced numeric elements which increment by `1` starting from zero.</span>
118119
- <span class="signature">[`gapx( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapx]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each element in a strided array.</span>
119120
- <span class="signature">[`gapxsum( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapxsum]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each strided array element and compute the sum.</span>
@@ -123,6 +124,7 @@ var o = ns;
123124
- <span class="signature">[`gapxsumpw( N, alpha, x, strideX )`][@stdlib/blas/ext/base/gapxsumpw]</span><span class="delimiter">: </span><span class="description">add a scalar constant to each strided array element and compute the sum using pairwise summation.</span>
124125
- <span class="signature">[`gasumpw( N, x, strideX )`][@stdlib/blas/ext/base/gasumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values (_L1_ norm) of strided array elements using pairwise summation.</span>
125126
- <span class="signature">[`gcartesianPower( order, N, k, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-power]</span><span class="delimiter">: </span><span class="description">compute the Cartesian power for a strided array.</span>
127+
- <span class="signature">[`gcartesianSquare( order, N, x, strideX, out, LDO )`][@stdlib/blas/ext/base/gcartesian-square]</span><span class="delimiter">: </span><span class="description">compute the Cartesian square for a strided array.</span>
126128
- <span class="signature">[`gcircshift( N, k, x, strideX )`][@stdlib/blas/ext/base/gcircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a strided array by a specified number of positions.</span>
127129
- <span class="signature">[`gconjoin( N, prefix, suffix, conjunction, oxfordComma, x, strideX )`][@stdlib/blas/ext/base/gconjoin]</span><span class="delimiter">: </span><span class="description">return a string created by joining strided array elements into a human-readable list using a conjunction.</span>
128130
- <span class="signature">[`gcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gcusum]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements.</span>
@@ -423,6 +425,8 @@ console.log( objectKeys( ns ) );
423425

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

428+
[@stdlib/blas/ext/base/dwhere]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dwhere
429+
426430
[@stdlib/blas/ext/base/dzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dzero-to
427431

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

442446
[@stdlib/blas/ext/base/gcartesian-power]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gcartesian-power
443447

448+
[@stdlib/blas/ext/base/gcartesian-square]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gcartesian-square
449+
444450
[@stdlib/blas/ext/base/gcircshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/gcircshift
445451

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ The namespace exports the following functions to manipulate multidimensional arr
118118
- <span class="signature">[`toFlippedlr( x )`][@stdlib/ndarray/to-flippedlr]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where the order of elements along the last dimension of an input `ndarray` is reversed.</span>
119119
- <span class="signature">[`toFlippedud( x )`][@stdlib/ndarray/to-flippedud]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where the order of elements along the second-to-last dimension of an input `ndarray` is reversed.</span>
120120
- <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>
121+
- <span class="signature">[`toReversedDimensions( x, dims )`][@stdlib/ndarray/to-reversed-dimensions]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where the order of elements of an input `ndarray` along specified dimensions is reversed.</span>
121122
- <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>
122123
- <span class="signature">[`toRot180( x[, options] )`][@stdlib/ndarray/to-rot180]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where an input `ndarray` is rotated `180` degrees in a specified plane.</span>
123124
- <span class="signature">[`toRot90( x[, options] )`][@stdlib/ndarray/to-rot90]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where an input `ndarray` is rotated `90` degrees in a specified plane.</span>
@@ -522,6 +523,8 @@ console.log( objectKeys( ns ) );
522523

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

526+
[@stdlib/ndarray/to-reversed-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed-dimensions
527+
525528
[@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed
526529

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

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ var o = ns;
7575
- <span class="signature">[`char2dtype( [ch] )`][@stdlib/ndarray/base/char2dtype]</span><span class="delimiter">: </span><span class="description">return the data type string associated with a provided single letter character abbreviation.</span>
7676
- <span class="signature">[`clampIndex( idx, max )`][@stdlib/ndarray/base/clamp-index]</span><span class="delimiter">: </span><span class="description">restrict an index to the interval `[0,max]`.</span>
7777
- <span class="signature">[`complementShape( shape, dims )`][@stdlib/ndarray/base/complement-shape]</span><span class="delimiter">: </span><span class="description">return the shape defined by the dimensions which are not included in a list of dimensions.</span>
78+
- <span class="signature">[`consensusOrder( strides )`][@stdlib/ndarray/base/consensus-order]</span><span class="delimiter">: </span><span class="description">resolve the most common underlying storage layout.</span>
7879
- <span class="signature">[`copy( x )`][@stdlib/ndarray/base/copy]</span><span class="delimiter">: </span><span class="description">copy an input ndarray to a new ndarray having the same shape and data type.</span>
7980
- <span class="signature">[`countFalsy( arrays )`][@stdlib/ndarray/base/count-falsy]</span><span class="delimiter">: </span><span class="description">count the number of falsy elements in an ndarray.</span>
8081
- <span class="signature">[`countIf( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/count-if]</span><span class="delimiter">: </span><span class="description">count the number of elements in an ndarray which pass a test implemented by a predicate function.</span>
@@ -158,6 +159,7 @@ var o = ns;
158159
- <span class="signature">[`ones( dtype, shape, order )`][@stdlib/ndarray/base/ones]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having a specified shape and data type.</span>
159160
- <span class="signature">[`order( x )`][@stdlib/ndarray/base/order]</span><span class="delimiter">: </span><span class="description">return the layout order of a provided ndarray.</span>
160161
- <span class="signature">[`outputDataType( dtypes, policy )`][@stdlib/ndarray/base/output-dtype]</span><span class="delimiter">: </span><span class="description">resolve the output ndarray data type from a list of input ndarray data types.</span>
162+
- <span class="signature">[`outputOrder( arrays )`][@stdlib/ndarray/base/output-order]</span><span class="delimiter">: </span><span class="description">resolves the order (i.e. memory layout) of an output ndarray according to a list of input ndarrays.</span>
161163
- <span class="signature">[`outputPolicyEnum2Str( policy )`][@stdlib/ndarray/base/output-policy-enum2str]</span><span class="delimiter">: </span><span class="description">return the policy string associated with an output ndarray data type policy enumeration constant.</span>
162164
- <span class="signature">[`outputPolicyResolveEnum( policy )`][@stdlib/ndarray/base/output-policy-resolve-enum]</span><span class="delimiter">: </span><span class="description">return the enumeration constant associated with a supported ndarray data type policy value.</span>
163165
- <span class="signature">[`outputPolicyResolveStr( dtype )`][@stdlib/ndarray/base/output-policy-resolve-str]</span><span class="delimiter">: </span><span class="description">return the policy string associated with a supported ndarray data type policy value.</span>
@@ -212,6 +214,7 @@ var o = ns;
212214
- <span class="signature">[`toFlippedud( x )`][@stdlib/ndarray/base/to-flippedud]</span><span class="delimiter">: </span><span class="description">return a new ndarray where the order of elements along the second-to-last dimension of an input ndarray is reversed.</span>
213215
- <span class="signature">[`toNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-normalized-indices]</span><span class="delimiter">: </span><span class="description">normalize a list of indices to the interval `[0,max]`.</span>
214216
- <span class="signature">[`toReversedDimension( x, dim )`][@stdlib/ndarray/base/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>
217+
- <span class="signature">[`toReversedDimensions( x, dims )`][@stdlib/ndarray/base/to-reversed-dimensions]</span><span class="delimiter">: </span><span class="description">return a new ndarray where the order of elements of an input ndarray along specified dimensions is reversed.</span>
215218
- <span class="signature">[`toReversed( x )`][@stdlib/ndarray/base/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>
216219
- <span class="signature">[`toRot180( x, dims )`][@stdlib/ndarray/base/to-rot180]</span><span class="delimiter">: </span><span class="description">return a new ndarray where an ndarray is rotated 180 degrees in a specified plane.</span>
217220
- <span class="signature">[`toRot90( x, dims, k )`][@stdlib/ndarray/base/to-rot90]</span><span class="delimiter">: </span><span class="description">return a new ndarray where an ndarray is rotated 90 degrees in a specified plane.</span>
@@ -369,6 +372,8 @@ console.log( objectKeys( ns ) );
369372

370373
[@stdlib/ndarray/base/complement-shape]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/complement-shape
371374

375+
[@stdlib/ndarray/base/consensus-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/consensus-order
376+
372377
[@stdlib/ndarray/base/copy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/copy
373378

374379
[@stdlib/ndarray/base/count-falsy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/count-falsy
@@ -535,6 +540,8 @@ console.log( objectKeys( ns ) );
535540

536541
[@stdlib/ndarray/base/output-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-dtype
537542

543+
[@stdlib/ndarray/base/output-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-order
544+
538545
[@stdlib/ndarray/base/output-policy-enum2str]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-policy-enum2str
539546

540547
[@stdlib/ndarray/base/output-policy-resolve-enum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/output-policy-resolve-enum
@@ -643,6 +650,8 @@ console.log( objectKeys( ns ) );
643650

644651
[@stdlib/ndarray/base/to-reversed-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed-dimension
645652

653+
[@stdlib/ndarray/base/to-reversed-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed-dimensions
654+
646655
[@stdlib/ndarray/base/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-reversed
647656

648657
[@stdlib/ndarray/base/to-rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-rot180

lib/node_modules/@stdlib/stats/strided/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The namespace exports the following:
108108
- <span class="signature">[`dnanmskminabs( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskminabs]</span><span class="delimiter">: </span><span class="description">calculate the minimum absolute value of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
109109
- <span class="signature">[`dnanmskrange( N, x, strideX, mask, strideMask )`][@stdlib/stats/strided/dnanmskrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array according to a mask, ignoring `NaN` values.</span>
110110
- <span class="signature">[`dnanrange( N, x, strideX )`][@stdlib/stats/strided/dnanrange]</span><span class="delimiter">: </span><span class="description">calculate the range of a double-precision floating-point strided array, ignoring `NaN` values.</span>
111-
- <span class="signature">[`dnanrangeabs( N, \*X, strideX )`][@stdlib/stats/strided/dnanrangeabs]</span><span class="delimiter">: </span><span class="description">compute the range of absolute values of a double-precision floating-point strided array, ignoring `NaN` values.</span>
111+
- <span class="signature">[`dnanrangeabs( N, x, strideX )`][@stdlib/stats/strided/dnanrangeabs]</span><span class="delimiter">: </span><span class="description">compute the range of absolute values of a double-precision floating-point strided array, ignoring `NaN` values.</span>
112112
- <span class="signature">[`dnanstdev( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdev]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values.</span>
113113
- <span class="signature">[`dnanstdevch( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdevch]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array ignoring `NaN` values and using a one-pass trial mean algorithm.</span>
114114
- <span class="signature">[`dnanstdevpn( N, correction, x, strideX )`][@stdlib/stats/strided/dnanstdevpn]</span><span class="delimiter">: </span><span class="description">calculate the standard deviation of a double-precision floating-point strided array, ignoring `NaN` values and using a two-pass algorithm.</span>

0 commit comments

Comments
 (0)