Skip to content

docs: update namespace table of contents #9938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 1 commit into from
Jan 28, 2026
+90 −0
Merged

docs: update namespace table of contents #9938

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,9 @@ var o = ns;
- <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>
- <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>
- <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>
- <span class="signature">[`quaternaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW, dtypeU )`][@stdlib/ndarray/base/quaternary-tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
- <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>
- <span class="signature">[`quinaryBlockSize( dtypeX, dtypeY, dtypeZ, dtypeW, dtypeU, dtypeV )`][@stdlib/ndarray/base/quinary-tiling-block-size]</span><span class="delimiter">: </span><span class="description">resolve a loop block size for multi-dimensional array tiled loops.</span>
- <span class="signature">[`removeSingletonDimensions( x )`][@stdlib/ndarray/base/remove-singleton-dimensions]</span><span class="delimiter">: </span><span class="description">remove singleton dimensions.</span>
- <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>
- <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>
Expand Down Expand Up @@ -178,6 +180,7 @@ var o = ns;
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
Expand Down Expand Up @@ -481,8 +484,12 @@ console.log( objectKeys( ns ) );

[@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

[@stdlib/ndarray/base/quaternary-tiling-block-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/quaternary-tiling-block-size

[@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

[@stdlib/ndarray/base/quinary-tiling-block-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/quinary-tiling-block-size

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

[@stdlib/ndarray/base/reverse-dimension]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/reverse-dimension
Expand Down Expand Up @@ -537,6 +544,8 @@ console.log( objectKeys( ns ) );

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

[@stdlib/ndarray/base/tiling-block-size]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/tiling-block-size

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

[@stdlib/ndarray/base/to-flippedlr]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/to-flippedlr
Expand Down
Loading