Skip to content

Commit 84d7a1f

Browse files
docs: update namespace table of contents
PR-URL: #11562 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 a0ef914 commit 84d7a1f

4 files changed

Lines changed: 36 additions & 0 deletions

File tree

lib/node_modules/@stdlib/blas/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">[`caxpy( arrays )`][@stdlib/blas/base/ndarray/caxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision complex floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision complex floating-point ndarray `y`.</span>
4849
- <span class="signature">[`dasum( arrays )`][@stdlib/blas/base/ndarray/dasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional double-precision floating-point ndarray.</span>
4950
- <span class="signature">[`daxpy( arrays )`][@stdlib/blas/base/ndarray/daxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional double-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional double-precision floating-point ndarray `y`.</span>
5051
- <span class="signature">[`ddot( arrays )`][@stdlib/blas/base/ndarray/ddot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional double-precision floating-point ndarrays.</span>
@@ -54,6 +55,7 @@ The namespace exposes the following APIs:
5455
- <span class="signature">[`sasum( arrays )`][@stdlib/blas/base/ndarray/sasum]</span><span class="delimiter">: </span><span class="description">calculate the sum of absolute values for all elements in a one-dimensional single-precision floating-point ndarray.</span>
5556
- <span class="signature">[`saxpy( arrays )`][@stdlib/blas/base/ndarray/saxpy]</span><span class="delimiter">: </span><span class="description">multiply a one-dimensional single-precision floating-point ndarray `x` by a constant `alpha` and add the result to a one-dimensional single-precision floating-point ndarray `y`.</span>
5657
- <span class="signature">[`sdot( arrays )`][@stdlib/blas/base/ndarray/sdot]</span><span class="delimiter">: </span><span class="description">calculate the dot product of two one-dimensional single-precision floating-point ndarrays.</span>
58+
- <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>
5759

5860
</div>
5961

@@ -96,6 +98,8 @@ console.log( objectKeys( ns ) );
9698

9799
<!-- <toc-links> -->
98100

101+
[@stdlib/blas/base/ndarray/caxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/caxpy
102+
99103
[@stdlib/blas/base/ndarray/dasum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/dasum
100104

101105
[@stdlib/blas/base/ndarray/daxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/daxpy
@@ -114,6 +118,8 @@ console.log( objectKeys( ns ) );
114118

115119
[@stdlib/blas/base/ndarray/sdot]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/sdot
116120

121+
[@stdlib/blas/base/ndarray/zaxpy]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/base/ndarray/zaxpy
122+
117123
<!-- </toc-links> -->
118124

119125
</section>

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ In addition, the namespace contains the following multidimensional array utility
7878
- <span class="signature">[`broadcastArrays( ...arrays )`][@stdlib/ndarray/broadcast-arrays]</span><span class="delimiter">: </span><span class="description">broadcast ndarrays to a common shape.</span>
7979
- <span class="signature">[`broadcastScalar( value, shape[, options] )`][@stdlib/ndarray/broadcast-scalar]</span><span class="delimiter">: </span><span class="description">broadcast a scalar value to an ndarray of a specified shape.</span>
8080
- <span class="signature">[`castingModes()`][@stdlib/ndarray/casting-modes]</span><span class="delimiter">: </span><span class="description">list of ndarray casting modes.</span>
81+
- <span class="signature">[`colcat( arrays )`][@stdlib/ndarray/colcat]</span><span class="delimiter">: </span><span class="description">concatenate a list of one-dimensional or two-dimensional ndarrays as columns.</span>
8182
- <span class="signature">[`concat( arrays[, options] )`][@stdlib/ndarray/concat]</span><span class="delimiter">: </span><span class="description">concatenate a list of ndarrays along a specified ndarray dimension.</span>
8283
- <span class="signature">[`concat1d( ...arrays )`][@stdlib/ndarray/concat1d]</span><span class="delimiter">: </span><span class="description">return a one-dimensional ndarray formed by concatenating provided input arguments.</span>
8384
- <span class="signature">[`copy( x[, options] )`][@stdlib/ndarray/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>
@@ -141,6 +142,7 @@ In addition, the namespace contains the following multidimensional array utility
141142
- <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>
142143
- <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>
143144
- <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>
145+
- <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>
144146
- <span class="signature">[`safeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast.</span>
145147
- <span class="signature">[`sameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]</span><span class="delimiter">: </span><span class="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".</span>
146148
- <span class="signature">[`shape( x )`][@stdlib/ndarray/shape]</span><span class="delimiter">: </span><span class="description">return the shape of a provided ndarray.</span>
@@ -228,6 +230,8 @@ console.log( objectKeys( ns ) );
228230

229231
[@stdlib/ndarray/casting-modes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/casting-modes
230232

233+
[@stdlib/ndarray/colcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/colcat
234+
231235
[@stdlib/ndarray/concat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat
232236

233237
[@stdlib/ndarray/concat1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/concat1d
@@ -354,6 +358,8 @@ console.log( objectKeys( ns ) );
354358

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

361+
[@stdlib/ndarray/rowcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rowcat
362+
357363
[@stdlib/ndarray/safe-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/safe-casts
358364

359365
[@stdlib/ndarray/same-kind-casts]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/same-kind-casts

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ var o = ns;
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>
4848
- <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>
4949
- <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>
50+
- <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>
51+
- <span class="signature">[`atleast2d( arrays )`][@stdlib/ndarray/base/atleast2d]</span><span class="delimiter">: </span><span class="description">convert a list of values (scalars and/or ndarrays) to ndarrays having at least two dimensions.</span>
52+
- <span class="signature">[`atleast3d( arrays )`][@stdlib/ndarray/base/atleast3d]</span><span class="delimiter">: </span><span class="description">convert a list of values (scalars and/or ndarrays) to ndarrays having at least three dimensions.</span>
5053
- <span class="signature">[`atleastnd( ndims, arrays )`][@stdlib/ndarray/base/atleastnd]</span><span class="delimiter">: </span><span class="description">convert a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.</span>
5154
- <span class="signature">[`binaryInputCastingDataType( idtype1, idtype2, odtype, policy )`][@stdlib/ndarray/base/binary-input-casting-dtype]</span><span class="delimiter">: </span><span class="description">resolve the casting data type for an input ndarray provided to a binary function.</span>
5255
- <span class="signature">[`binaryLoopOrder( shape, stridesX, stridesY, stridesZ )`][@stdlib/ndarray/base/binary-loop-interchange-order]</span><span class="delimiter">: </span><span class="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
@@ -98,6 +101,7 @@ var o = ns;
98101
- <span class="signature">[`everyBy( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/every-by]</span><span class="delimiter">: </span><span class="description">test whether all elements in an ndarray pass a test implemented by a predicate function.</span>
99102
- <span class="signature">[`every( arrays )`][@stdlib/ndarray/base/every]</span><span class="delimiter">: </span><span class="description">test whether every element in an ndarray is truthy.</span>
100103
- <span class="signature">[`expandDimensions( x, dim, writable )`][@stdlib/ndarray/base/expand-dimensions]</span><span class="delimiter">: </span><span class="description">expand the shape of an array by inserting a new dimension of size one at a specified dimension index.</span>
104+
- <span class="signature">[`falses( dtype, shape, order )`][@stdlib/ndarray/base/falses]</span><span class="delimiter">: </span><span class="description">create an ndarray filled with `false` values and having a specified shape and data type.</span>
101105
- <span class="signature">[`fillBy( x, fcn[, thisArg] )`][@stdlib/ndarray/base/fill-by]</span><span class="delimiter">: </span><span class="description">fill an input ndarray according to a callback function.</span>
102106
- <span class="signature">[`fill( x, value )`][@stdlib/ndarray/base/fill]</span><span class="delimiter">: </span><span class="description">fill an input ndarray with a specified value.</span>
103107
- <span class="signature">[`find( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/find]</span><span class="delimiter">: </span><span class="description">return the first element in an ndarray which passes a test implemented by a predicate function.</span>
@@ -190,6 +194,7 @@ var o = ns;
190194
- <span class="signature">[`ternaryOutputDataType( xdtype, ydtype, zdtype, policy )`][@stdlib/ndarray/base/ternary-output-dtype]</span><span class="delimiter">: </span><span class="description">resolve the output ndarray data type for a ternary function.</span>
191195
- <span class="signature">[`ternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW )`][@stdlib/ndarray/base/ternary-tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
192196
- <span class="signature">[`ternary( arrays, fcn )`][@stdlib/ndarray/base/ternary]</span><span class="delimiter">: </span><span class="description">apply a ternary callback to elements in input ndarrays and assign results to elements in an output ndarray.</span>
197+
- <span class="signature">[`tile( x, reps )`][@stdlib/ndarray/base/tile]</span><span class="delimiter">: </span><span class="description">return an ndarray created by repeating the elements of an input ndarray a specified number of times along each dimension.</span>
193198
- <span class="signature">[`blockSize( dtypes )`][@stdlib/ndarray/base/tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
194199
- <span class="signature">[`ndarray2array( buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/to-array]</span><span class="delimiter">: </span><span class="description">convert an ndarray buffer to a generic array.</span>
195200
- <span class="signature">[`toFlippedlr( x )`][@stdlib/ndarray/base/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>
@@ -201,6 +206,7 @@ var o = ns;
201206
- <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>
202207
- <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>
203208
- <span class="signature">[`transpose( x, writable )`][@stdlib/ndarray/base/transpose]</span><span class="delimiter">: </span><span class="description">transpose a matrix (or a stack of matrices).</span>
209+
- <span class="signature">[`trues( dtype, shape, order )`][@stdlib/ndarray/base/trues]</span><span class="delimiter">: </span><span class="description">create an ndarray filled with `true` values and having a specified shape and data type.</span>
204210
- <span class="signature">[`unaryAccumulate( arrays, initial, clbk )`][@stdlib/ndarray/base/unary-accumulate]</span><span class="delimiter">: </span><span class="description">perform a reduction over elements in an input ndarray.</span>
205211
- <span class="signature">[`unaryAddonDispatch( addon, fallback )`][@stdlib/ndarray/base/unary-addon-dispatch]</span><span class="delimiter">: </span><span class="description">dispatch to a native add-on applying a unary function to an input ndarray.</span>
206212
- <span class="signature">[`unaryBy( arrays, fcn, clbk[, thisArg] )`][@stdlib/ndarray/base/unary-by]</span><span class="delimiter">: </span><span class="description">apply a unary function to each element in an input ndarray according to a callback function and assign results to elements in an output ndarray.</span>
@@ -292,6 +298,12 @@ console.log( objectKeys( ns ) );
292298

293299
[@stdlib/ndarray/base/assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assign
294300

301+
[@stdlib/ndarray/base/atleast1d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/atleast1d
302+
303+
[@stdlib/ndarray/base/atleast2d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/atleast2d
304+
305+
[@stdlib/ndarray/base/atleast3d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/atleast3d
306+
295307
[@stdlib/ndarray/base/atleastnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/atleastnd
296308

297309
[@stdlib/ndarray/base/binary-input-casting-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/binary-input-casting-dtype
@@ -394,6 +406,8 @@ console.log( objectKeys( ns ) );
394406

395407
[@stdlib/ndarray/base/expand-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/expand-dimensions
396408

409+
[@stdlib/ndarray/base/falses]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/falses
410+
397411
[@stdlib/ndarray/base/fill-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill-by
398412

399413
[@stdlib/ndarray/base/fill]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill
@@ -578,6 +592,8 @@ console.log( objectKeys( ns ) );
578592

579593
[@stdlib/ndarray/base/ternary]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ternary
580594

595+
[@stdlib/ndarray/base/tile]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/tile
596+
581597
[@stdlib/ndarray/base/tiling-block-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/tiling-block-size
582598

583599
[@stdlib/ndarray/base/to-array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-array
@@ -600,6 +616,8 @@ console.log( objectKeys( ns ) );
600616

601617
[@stdlib/ndarray/base/transpose]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/transpose
602618

619+
[@stdlib/ndarray/base/trues]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/trues
620+
603621
[@stdlib/ndarray/base/unary-accumulate]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-accumulate
604622

605623
[@stdlib/ndarray/base/unary-addon-dispatch]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/unary-addon-dispatch

0 commit comments

Comments
 (0)