From 85c420b2a9f7fcbe0f82338416627eef37d98bb5 Mon Sep 17 00:00:00 2001 From: Planeshifter <1913638+Planeshifter@users.noreply.github.com> Date: Sun, 3 May 2026 03:27:50 +0000 Subject: [PATCH] docs: update namespace table of contents Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- lib/node_modules/@stdlib/ndarray/README.md | 36 +++++++++++----------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/node_modules/@stdlib/ndarray/README.md b/lib/node_modules/@stdlib/ndarray/README.md index f81edfa14dd1..b548bf7c8f8e 100644 --- a/lib/node_modules/@stdlib/ndarray/README.md +++ b/lib/node_modules/@stdlib/ndarray/README.md @@ -99,7 +99,9 @@ The namespace exports the following functions to manipulate multidimensional arr - [`removeSingletonDimensions( x )`][@stdlib/ndarray/remove-singleton-dimensions]: return a read-only view of an input ndarray with singleton dimensions removed. - [`reverseDimension( x, dim )`][@stdlib/ndarray/reverse-dimension]: return a **read-only** view of an input `ndarray` in which the order of elements along a specified dimension is reversed. - [`reverse( x )`][@stdlib/ndarray/reverse]: return a **read-only** view of an input `ndarray` in which the order of elements along each dimension is reversed. +- [`rot180( x[, options] )`][@stdlib/ndarray/rot180]: return a **read-only** view of an input ndarray rotated `180` degrees in a specified plane. - [`rot90( x[, options] )`][@stdlib/ndarray/rot90]: return a **read-only** view of an input ndarray rotated `90` degrees in a specified plane. +- [`rotl90( x, k )`][@stdlib/ndarray/rotl90]: return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees counterclockwise. - [`rotr90( x, k )`][@stdlib/ndarray/rotr90]: return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees clockwise. - [`rowcat( arrays )`][@stdlib/ndarray/rowcat]: concatenate a list of one-dimensional or two-dimensional ndarrays as rows. - [`shift( x[, options] )`][@stdlib/ndarray/shift]: 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. @@ -115,6 +117,10 @@ The namespace exports the following functions to manipulate multidimensional arr - [`toFlippedud( x )`][@stdlib/ndarray/to-flippedud]: return a new `ndarray` where the order of elements along the second-to-last dimension of an input `ndarray` is reversed. - [`toReversedDimension( x[, options] )`][@stdlib/ndarray/to-reversed-dimension]: return a new ndarray where the order of elements of an input ndarray along a specified dimension is reversed. - [`toReversed( x )`][@stdlib/ndarray/to-reversed]: return a new `ndarray` where the order of elements of an input `ndarray` is reversed along each dimension. +- [`toRot180( x[, options] )`][@stdlib/ndarray/to-rot180]: return a new `ndarray` where an input `ndarray` is rotated `180` degrees in a specified plane. +- [`toRot90( x[, options] )`][@stdlib/ndarray/to-rot90]: return a new `ndarray` where an input `ndarray` is rotated `90` degrees in a specified plane. +- [`toRotl90( x, k )`][@stdlib/ndarray/to-rotl90]: return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees counterclockwise. +- [`toRotr90( x, k )`][@stdlib/ndarray/to-rotr90]: return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees clockwise. - [`unshift( x, ...values )`][@stdlib/ndarray/unshift]: return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray. - [`vconcat( arrays )`][@stdlib/ndarray/vconcat]: concatenate a list of ndarrays along the second-to-last dimension. - [`ndarrayWith( x, indices, value )`][@stdlib/ndarray/with]: return a new ndarray with the element at a specified index replaced by a provided value. @@ -264,12 +270,6 @@ The namespace contains the following multidimensional array utility functions: - [`forEach( x, fcn[, thisArg] )`][@stdlib/ndarray/for-each]: invoke a callback function once for each ndarray element. - [`ndarraylike2scalar( x )`][@stdlib/ndarray/ndarraylike2scalar]: convert an ndarray-like object to a scalar value. - [`orders()`][@stdlib/ndarray/orders]: list of ndarray orders. -- [`rot180( x[, options] )`][@stdlib/ndarray/rot180]: return a **read-only** view of an input ndarray rotated `180` degrees in a specified plane. -- [`rotl90( x, k )`][@stdlib/ndarray/rotl90]: return a **read-only** view of a matrix (or a stack of matrices) rotated `90` degrees counterclockwise. -- [`toRot180( x[, options] )`][@stdlib/ndarray/to-rot180]: return a new `ndarray` where an input `ndarray` is rotated `180` degrees in a specified plane. -- [`toRot90( x[, options] )`][@stdlib/ndarray/to-rot90]: return a new `ndarray` where an input `ndarray` is rotated `90` degrees in a specified plane. -- [`toRotl90( x, k )`][@stdlib/ndarray/to-rotl90]: return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees counterclockwise. -- [`toRotr90( x, k )`][@stdlib/ndarray/to-rotr90]: return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees clockwise. - [`unflatten( x, dim, sizes )`][@stdlib/ndarray/unflatten]: return a read-only view of an input ndarray in which a specified dimension is expanded over multiple dimensions. @@ -323,18 +323,6 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/orders]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/orders -[@stdlib/ndarray/rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rot180 - -[@stdlib/ndarray/rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rotl90 - -[@stdlib/ndarray/to-rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rot180 - -[@stdlib/ndarray/to-rot90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rot90 - -[@stdlib/ndarray/to-rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rotl90 - -[@stdlib/ndarray/to-rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rotr90 - [@stdlib/ndarray/unflatten]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unflatten [@stdlib/ndarray/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base @@ -489,8 +477,12 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/reverse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/reverse +[@stdlib/ndarray/rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rot180 + [@stdlib/ndarray/rot90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rot90 +[@stdlib/ndarray/rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rotl90 + [@stdlib/ndarray/rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rotr90 [@stdlib/ndarray/rowcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/rowcat @@ -521,6 +513,14 @@ console.log( objectKeys( ns ) ); [@stdlib/ndarray/to-reversed]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-reversed +[@stdlib/ndarray/to-rot180]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rot180 + +[@stdlib/ndarray/to-rot90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rot90 + +[@stdlib/ndarray/to-rotl90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rotl90 + +[@stdlib/ndarray/to-rotr90]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/to-rotr90 + [@stdlib/ndarray/unshift]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/unshift [@stdlib/ndarray/vconcat]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vconcat