Skip to content

docs: update namespace table of contents #14367

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
Aug 18, 2026
+6 −0
Merged

docs: update namespace table of contents #14367

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
6 changes: 6 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 @@ -161,6 +161,7 @@ var o = ns;
- <span class="signature">[`numelDimension( x, dim )`][@stdlib/ndarray/base/numel-dimension]</span><span class="delimiter">: </span><span class="description">return the size (i.e., number of elements) of a specified dimension for a provided ndarray.</span>
- <span class="signature">[`numel( shape )`][@stdlib/ndarray/base/numel]</span><span class="delimiter">: </span><span class="description">return the number of elements in an array.</span>
- <span class="signature">[`offset( x )`][@stdlib/ndarray/base/offset]</span><span class="delimiter">: </span><span class="description">return the index offset specifying the underlying buffer index of the first iterated ndarray element.</span>
- <span class="signature">[`offsets( arrays )`][@stdlib/ndarray/base/offsets]</span><span class="delimiter">: </span><span class="description">return the index offset specifying the underlying buffer index of the first iterated element for each ndarray in a provided list of ndarrays.</span>
- <span class="signature">[`onesLike( x )`][@stdlib/ndarray/base/ones-like]</span><span class="delimiter">: </span><span class="description">create a ones-filled ndarray having the same shape and data type as a provided ndarray.</span>
- <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>
- <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>
Expand Down Expand Up @@ -190,6 +191,7 @@ var o = ns;
- <span class="signature">[`rotl90( x, k, writable )`][@stdlib/ndarray/base/rotl90]</span><span class="delimiter">: </span><span class="description">rotate a matrix (or a stack of matrices) 90 degrees counterclockwise.</span>
- <span class="signature">[`rotr90( x, k, writable )`][@stdlib/ndarray/base/rotr90]</span><span class="delimiter">: </span><span class="description">rotate a matrix (or a stack of matrices) 90 degrees clockwise.</span>
- <span class="signature">[`serializeMetaData( x )`][@stdlib/ndarray/base/serialize-meta-data]</span><span class="delimiter">: </span><span class="description">serialize ndarray meta data.</span>
- <span class="signature">[`setDescriptorOffsets( descriptors, offsets )`][@stdlib/ndarray/base/set-descriptor-offsets]</span><span class="delimiter">: </span><span class="description">set ndarray descriptor index offsets.</span>
- <span class="signature">[`shape( x, copy )`][@stdlib/ndarray/base/shape]</span><span class="delimiter">: </span><span class="description">return the shape of a provided ndarray.</span>
- <span class="signature">[`shape2strides( shape, order )`][@stdlib/ndarray/base/shape2strides]</span><span class="delimiter">: </span><span class="description">generate a stride array from an array shape.</span>
- <span class="signature">[`shift( x, dim, writable )`][@stdlib/ndarray/base/shift]</span><span class="delimiter">: </span><span class="description">return an array containing a truncated view of an input ndarray and a view of the first element(s) along a specified dimension.</span>
Expand Down Expand Up @@ -551,6 +553,8 @@ console.log( objectKeys( ns ) );

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

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

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

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

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

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

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

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