Skip to content

Commit 99f1a7f

Browse files
Planeshifterstdlib-bot
authored andcommitted
docs: update namespace table of contents
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent f693285 commit 99f1a7f

File tree

2 files changed

+183
-0
lines changed

2 files changed

+183
-0
lines changed

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ var o = ns;
5858
- <span class="signature">[`broadcastArrayExceptDimensions( arr, shape, dims )`][@stdlib/ndarray/base/broadcast-array-except-dimensions]</span><span class="delimiter">: </span><span class="description">broadcast an input ndarray to a target shape while keeping a list of specified dimensions unchanged.</span>
5959
- <span class="signature">[`broadcastArray( arr, shape )`][@stdlib/ndarray/base/broadcast-array]</span><span class="delimiter">: </span><span class="description">broadcast an ndarray to a specified shape.</span>
6060
- <span class="signature">[`broadcastArrays( arrays )`][@stdlib/ndarray/base/broadcast-arrays]</span><span class="delimiter">: </span><span class="description">broadcast ndarrays to a common shape.</span>
61+
- <span class="signature">[`broadcastScalarLike( x, value )`][@stdlib/ndarray/base/broadcast-scalar-like]</span><span class="delimiter">: </span><span class="description">broadcast a scalar value to an ndarray having the same shape and data type as a provided input ndarray.</span>
6162
- <span class="signature">[`broadcastScalar( value, dtype, shape, order )`][@stdlib/ndarray/base/broadcast-scalar]</span><span class="delimiter">: </span><span class="description">broadcast a scalar value to an ndarray having a specified shape.</span>
6263
- <span class="signature">[`broadcastShapes( shapes )`][@stdlib/ndarray/base/broadcast-shapes]</span><span class="delimiter">: </span><span class="description">broadcast array shapes to a single shape.</span>
6364
- <span class="signature">[`bufferCtors( dtype )`][@stdlib/ndarray/base/buffer-ctors]</span><span class="delimiter">: </span><span class="description">ndarray data buffer constructors.</span>
@@ -148,6 +149,8 @@ var o = ns;
148149
- <span class="signature">[`pop( x, dim, writable )`][@stdlib/ndarray/base/pop]</span><span class="delimiter">: </span><span class="description">return an array containing a truncated view of an input ndarray and a view of the last element(s) along a specified dimension.</span>
149150
- <span class="signature">[`prependSingletonDimensions( x, n, writable )`][@stdlib/ndarray/base/prepend-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">prepend singleton dimensions.</span>
150151
- <span class="signature">[`promoteDataTypes( dtypes )`][@stdlib/ndarray/base/promote-dtypes]</span><span class="delimiter">: </span><span class="description">resolve the data type that results from applying promotion rules to a provided list of data types.</span>
152+
- <span class="signature">[`quaternaryLoopOrder( shape, stridesX, stridesY, stridesZ, stridesW, stridesU )`][@stdlib/ndarray/base/quaternary-loop-interchange-order]</span><span class="delimiter">: </span><span class="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
153+
- <span class="signature">[`quinaryLoopOrder( shape, stridesX, stridesY, stridesZ, stridesW, stridesU, stridesV )`][@stdlib/ndarray/base/quinary-loop-interchange-order]</span><span class="delimiter">: </span><span class="description">reorder ndarray dimensions and associated strides for loop interchange.</span>
151154
- <span class="signature">[`removeSingletonDimensions( x )`][@stdlib/ndarray/base/remove-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">remove singleton dimensions.</span>
152155
- <span class="signature">[`reverseDimension( x, dim, writable )`][@stdlib/ndarray/base/reverse-dimension]</span><span class="delimiter">: </span><span class="description">return a view of an input ndarray in which the order of elements along a specified dimension is reversed.</span>
153156
- <span class="signature">[`reverse( x, writable )`][@stdlib/ndarray/base/reverse]</span><span class="delimiter">: </span><span class="description">return a view of an input ndarray in which the order of elements along each dimension is reversed.</span>
@@ -294,6 +297,8 @@ console.log( objectKeys( ns ) );
294297

295298
[@stdlib/ndarray/base/broadcast-arrays]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-arrays
296299

300+
[@stdlib/ndarray/base/broadcast-scalar-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-scalar-like
301+
297302
[@stdlib/ndarray/base/broadcast-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-scalar
298303

299304
[@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
@@ -474,6 +479,10 @@ console.log( objectKeys( ns ) );
474479

475480
[@stdlib/ndarray/base/promote-dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/promote-dtypes
476481

482+
[@stdlib/ndarray/base/quaternary-loop-interchange-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/quaternary-loop-interchange-order
483+
484+
[@stdlib/ndarray/base/quinary-loop-interchange-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/quinary-loop-interchange-order
485+
477486
[@stdlib/ndarray/base/remove-singleton-dimensions]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/remove-singleton-dimensions
478487

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

0 commit comments

Comments
 (0)