Skip to content

Commit 7442c80

Browse files
docs: update namespace table of contents
PR-URL: #11789 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent efefff5 commit 7442c80

5 files changed

Lines changed: 31 additions & 1 deletion

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ The namespace contains the following:
5858
- <span class="signature">[`sort( x[, sortOrder][, options] )`][@stdlib/blas/ext/sort]</span><span class="delimiter">: </span><span class="description">sort an input ndarray along one or more ndarray dimensions.</span>
5959
- <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>
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>
61+
- <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>
6162
- <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>
6263
- <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>
6364

@@ -128,6 +129,8 @@ console.log( objectKeys( ns ) );
128129

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

132+
[@stdlib/blas/ext/to-sorted]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/to-sorted
133+
131134
[@stdlib/blas/ext/to-sortedhp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/to-sortedhp
132135

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

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ The namespace exposes the following APIs:
100100
- <span class="signature">[`gsumkbn2( arrays )`][@stdlib/blas/ext/base/ndarray/gsumkbn2]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using a second-order iterative Kahan–Babuška algorithm.</span>
101101
- <span class="signature">[`gsumors( arrays )`][@stdlib/blas/ext/base/ndarray/gsumors]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using ordinary recursive summation.</span>
102102
- <span class="signature">[`gsumpw( arrays )`][@stdlib/blas/ext/base/ndarray/gsumpw]</span><span class="delimiter">: </span><span class="description">compute the sum of all elements in a one-dimensional ndarray using pairwise summation.</span>
103+
- <span class="signature">[`gunitspace( arrays )`][@stdlib/blas/ext/base/ndarray/gunitspace]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from a specified value.</span>
103104
- <span class="signature">[`gzeroTo( arrays )`][@stdlib/blas/ext/base/ndarray/gzero-to]</span><span class="delimiter">: </span><span class="description">fill a one-dimensional ndarray with linearly spaced numeric elements which increment by `1` starting from zero.</span>
104105
- <span class="signature">[`scircshift( arrays )`][@stdlib/blas/ext/base/ndarray/scircshift]</span><span class="delimiter">: </span><span class="description">circularly shift the elements of a one-dimensional single-precision floating-point ndarray by a specified number of positions.</span>
105106
- <span class="signature">[`scusum( arrays )`][@stdlib/blas/ext/base/ndarray/scusum]</span><span class="delimiter">: </span><span class="description">compute the cumulative sum of a one-dimensional single-precision floating-point ndarray.</span>
@@ -279,6 +280,8 @@ console.log( objectKeys( ns ) );
279280

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

283+
[@stdlib/blas/ext/base/ndarray/gunitspace]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gunitspace
284+
282285
[@stdlib/blas/ext/base/ndarray/gzero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ndarray/gzero-to
283286

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Constants are split across the following sub-namespaces:
4646
<div class="namespace-toc">
4747

4848
- <span class="signature">[`array`][@stdlib/constants/array]</span><span class="delimiter">: </span><span class="description">array constants.</span>
49-
- <span class="signature">[`complex128`][@stdlib/constants/complex128]</span><span class="delimiter">: </span><span class="description">128-bit complex number mathematical constant.</span>
49+
- <span class="signature">[`complex128`][@stdlib/constants/complex128]</span><span class="delimiter">: </span><span class="description">128-bit complex number mathematical constants.</span>
5050
- <span class="signature">[`complex64`][@stdlib/constants/complex64]</span><span class="delimiter">: </span><span class="description">half-precision floating-point mathematical constants.</span>
5151
- <span class="signature">[`float16`][@stdlib/constants/float16]</span><span class="delimiter">: </span><span class="description">half-precision floating-point mathematical constants.</span>
5252
- <span class="signature">[`float32`][@stdlib/constants/float32]</span><span class="delimiter">: </span><span class="description">single-precision floating-point mathematical constants.</span>

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ The namespace exports the following functions to manipulate multidimensional arr
9999
- <span class="signature">[`removeSingletonDimensions( x )`][@stdlib/ndarray/remove-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray with singleton dimensions removed.</span>
100100
- <span class="signature">[`reverseDimension( x, dim )`][@stdlib/ndarray/reverse-dimension]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input `ndarray` in which the order of elements along a specified dimension is reversed.</span>
101101
- <span class="signature">[`reverse( x )`][@stdlib/ndarray/reverse]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input `ndarray` in which the order of elements along each dimension is reversed.</span>
102+
- <span class="signature">[`rot90( x[, options] )`][@stdlib/ndarray/rot90]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input ndarray rotated `90` degrees in a specified plane.</span>
102103
- <span class="signature">[`rotr90( x, k )`][@stdlib/ndarray/rotr90]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees clockwise.</span>
103104
- <span class="signature">[`rowcat( arrays )`][@stdlib/ndarray/rowcat]</span><span class="delimiter">: </span><span class="description">concatenate a list of one-dimensional or two-dimensional ndarrays as rows.</span>
104105
- <span class="signature">[`shift( x[, options] )`][@stdlib/ndarray/shift]</span><span class="delimiter">: </span><span class="description">return an array containing a read-only truncated view of an input `ndarray` and a read-only view of the first element(s) along a specified dimension.</span>
@@ -262,6 +263,9 @@ The namespace contains the following multidimensional array utility functions:
262263
- <span class="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]</span><span class="delimiter">: </span><span class="description">create an ndarray function interface which performs multiple dispatch.</span>
263264
- <span class="signature">[`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]</span><span class="delimiter">: </span><span class="description">invoke a callback function once for each ndarray element.</span>
264265
- <span class="signature">[`orders()`][@stdlib/ndarray/orders]</span><span class="delimiter">: </span><span class="description">list of ndarray orders.</span>
266+
- <span class="signature">[`rot180( x[, options] )`][@stdlib/ndarray/rot180]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input ndarray rotated `180` degrees in a specified plane.</span>
267+
- <span class="signature">[`rotl90( x, k )`][@stdlib/ndarray/rotl90]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees counterclockwise.</span>
268+
- <span class="signature">[`toRotr90( x, k )`][@stdlib/ndarray/to-rotr90]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees clockwise.</span>
265269

266270
</div>
267271

@@ -312,6 +316,12 @@ console.log( objectKeys( ns ) );
312316

313317
[@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders
314318

319+
[@stdlib/ndarray/rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rot180
320+
321+
[@stdlib/ndarray/rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rotl90
322+
323+
[@stdlib/ndarray/to-rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rotr90
324+
315325
[@stdlib/ndarray/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base
316326

317327
[@stdlib/ndarray/iter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/iter
@@ -464,6 +474,8 @@ console.log( objectKeys( ns ) );
464474

465475
[@stdlib/ndarray/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse
466476

477+
[@stdlib/ndarray/rot90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rot90
478+
467479
[@stdlib/ndarray/rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rotr90
468480

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

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ var o = ns;
4545

4646
- <span class="signature">[`anyBy( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an ndarray passes a test implemented by a predicate function.</span>
4747
- <span class="signature">[`any( arrays )`][@stdlib/ndarray/base/any]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an ndarray is truthy.</span>
48+
- <span class="signature">[`appendSingletonDimensions( x, n, writable )`][@stdlib/ndarray/base/append-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">append singleton dimensions.</span>
4849
- <span class="signature">[`assignScalar( arrays )`][@stdlib/ndarray/base/assign-scalar]</span><span class="delimiter">: </span><span class="description">assign a scalar value to every element of an output ndarray.</span>
4950
- <span class="signature">[`assign( arrays )`][@stdlib/ndarray/base/assign]</span><span class="delimiter">: </span><span class="description">assign elements in an input ndarray to elements in an output ndarray.</span>
5051
- <span class="signature">[`atleast1d( arrays )`][@stdlib/ndarray/base/atleast1d]</span><span class="delimiter">: </span><span class="description">convert a list of values (scalars and/or ndarrays) to ndarrays having at least one dimension.</span>
@@ -208,6 +209,9 @@ var o = ns;
208209
- <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>
209210
- <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>
210211
- <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>
212+
- <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>
213+
- <span class="signature">[`toRotl90( x, k )`][@stdlib/ndarray/base/to-rotl90]</span><span class="delimiter">: </span><span class="description">return a new ndarray where a matrix (or a stack of matrices) is rotated 90 degrees counterclockwise.</span>
214+
- <span class="signature">[`toRotr90( x, k )`][@stdlib/ndarray/base/to-rotr90]</span><span class="delimiter">: </span><span class="description">return a new ndarray where a matrix (or a stack of matrices) is rotated 90 degrees clockwise.</span>
211215
- <span class="signature">[`toTransposed( x )`][@stdlib/ndarray/base/to-transposed]</span><span class="delimiter">: </span><span class="description">return a new ndarray containing the elements of an input ndarray but whose last two dimensions are transposed.</span>
212216
- <span class="signature">[`toUnflattened( x, dim, sizes )`][@stdlib/ndarray/base/to-unflattened]</span><span class="delimiter">: </span><span class="description">return a new ndarray in which a specified dimension of an input ndarray is expanded over multiple dimensions.</span>
213217
- <span class="signature">[`toUniqueNormalizedIndices( indices, max )`][@stdlib/ndarray/base/to-unique-normalized-indices]</span><span class="delimiter">: </span><span class="description">return a list of unique indices after normalizing to the interval `[0,max]`.</span>
@@ -300,6 +304,8 @@ console.log( objectKeys( ns ) );
300304

301305
[@stdlib/ndarray/base/any]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/any
302306

307+
[@stdlib/ndarray/base/append-singleton-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/append-singleton-dimensions
308+
303309
[@stdlib/ndarray/base/assign-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assign-scalar
304310

305311
[@stdlib/ndarray/base/assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assign
@@ -626,6 +632,12 @@ console.log( objectKeys( ns ) );
626632

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

635+
[@stdlib/ndarray/base/to-rot90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-rot90
636+
637+
[@stdlib/ndarray/base/to-rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-rotl90
638+
639+
[@stdlib/ndarray/base/to-rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-rotr90
640+
629641
[@stdlib/ndarray/base/to-transposed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-transposed
630642

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

0 commit comments

Comments
 (0)