Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -932,6 +932,7 @@ A total of 49 issues were closed in this release:
 
 <details>
 
+-   [`c534f97`](https://github.com/stdlib-js/stdlib/commit/c534f971488b2a5ebacca4dccf73a9d9b4e09bc7) - **docs:** update namespace table of contents [(#12092)](https://github.com/stdlib-js/stdlib/pull/12092) _(by stdlib-bot)_
 -   [`25ae5aa`](https://github.com/stdlib-js/stdlib/commit/25ae5aa59b431b6b562e4fe36b69b3186111af12) - **refactor:** update error message _(by Athan Reines)_
 -   [`ca918f8`](https://github.com/stdlib-js/stdlib/commit/ca918f82273615d9785f80d703bcf24391bb516b) - **docs:** update ToC _(by Athan Reines)_
 -   [`e38bbc8`](https://github.com/stdlib-js/stdlib/commit/e38bbc844b58b38ccb22be0ee62b0a42aa90fd75) - **feat:** add `transpose` and `toTransposed` to namespace _(by Athan Reines)_

README.md

@@ -157,7 +157,9 @@ The namespace exports the following functions to manipulate multidimensional arr
 -   <span class="signature">[`toRot90( x[, options] )`][@stdlib/ndarray/to-rot90]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where an input `ndarray` is rotated `90` degrees in a specified plane.</span>
 -   <span class="signature">[`toRotl90( x, k )`][@stdlib/ndarray/to-rotl90]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees counterclockwise.</span>
 -   <span class="signature">[`toRotr90( x, k )`][@stdlib/ndarray/to-rotr90]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` where a matrix (or a stack of matrices) is rotated 90 degrees clockwise.</span>
+-   <span class="signature">[`toTransposed( x )`][@stdlib/ndarray/to-transposed]</span><span class="delimiter">: </span><span class="description">return a new `ndarray` containing the elements of an input `ndarray` but whose last two dimensions are transposed.</span>
 -   <span class="signature">[`toUnflattened( x, dim, sizes )`][@stdlib/ndarray/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>
+-   <span class="signature">[`transpose( x )`][@stdlib/ndarray/transpose]</span><span class="delimiter">: </span><span class="description">return a **read-only** view of an input `ndarray` in which the last two dimensions are transposed.</span>
 -   <span class="signature">[`unflatten( x, dim, sizes )`][@stdlib/ndarray/unflatten]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray in which a specified dimension is expanded over multiple dimensions.</span>
 -   <span class="signature">[`unshift( x, ...values )`][@stdlib/ndarray/unshift]</span><span class="delimiter">: </span><span class="description">return a one-dimensional ndarray formed by prepending provided scalar values to a one-dimensional input ndarray.</span>
 -   <span class="signature">[`vconcat( arrays )`][@stdlib/ndarray/vconcat]</span><span class="delimiter">: </span><span class="description">concatenate a list of ndarrays along the second-to-last dimension.</span>
@@ -636,8 +638,12 @@ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 [@stdlib/ndarray/to-rotr90]: https://github.com/stdlib-js/ndarray/tree/main/to-rotr90
 
+[@stdlib/ndarray/to-transposed]: https://github.com/stdlib-js/ndarray/tree/main/to-transposed
+
 [@stdlib/ndarray/to-unflattened]: https://github.com/stdlib-js/ndarray/tree/main/to-unflattened
 
+[@stdlib/ndarray/transpose]: https://github.com/stdlib-js/ndarray/tree/main/transpose
+
 [@stdlib/ndarray/unflatten]: https://github.com/stdlib-js/ndarray/tree/main/unflatten
 
 [@stdlib/ndarray/unshift]: https://github.com/stdlib-js/ndarray/tree/main/unshift

base/README.md

@@ -82,6 +82,7 @@ var o = ns;
 -   <span class="signature">[`countTruthy( arrays )`][@stdlib/ndarray/base/count-truthy]</span><span class="delimiter">: </span><span class="description">count the number of truthy elements in an ndarray.</span>
 -   <span class="signature">[`ndarray( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/ctor]</span><span class="delimiter">: </span><span class="description">create a multidimensional array.</span>
 -   <span class="signature">[`data( x )`][@stdlib/ndarray/base/data-buffer]</span><span class="delimiter">: </span><span class="description">return the underlying data buffer of a provided ndarray.</span>
+-   <span class="signature">[`descriptor( dtype, buffer, shape, strides, offset, order )`][@stdlib/ndarray/base/descriptor]</span><span class="delimiter">: </span><span class="description">create a plain object describing how to interpret a data buffer as an n-dimensional array.</span>
 -   <span class="signature">[`diagonal( x, dims, k, writable )`][@stdlib/ndarray/base/diagonal]</span><span class="delimiter">: </span><span class="description">return a view of the diagonal of a matrix (or stack of matrices).</span>
 -   <span class="signature">[`dtypeAlignment( [dtype] )`][@stdlib/ndarray/base/dtype-alignment]</span><span class="delimiter">: </span><span class="description">return the alignment (in bytes) for an underlying array data type.</span>
 -   <span class="signature">[`dtypeChar( [dtype] )`][@stdlib/ndarray/base/dtype-char]</span><span class="delimiter">: </span><span class="description">return the single letter abbreviation for an underlying array data type.</span>
@@ -386,6 +387,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/base/data-buffer]: https://github.com/stdlib-js/ndarray/tree/main/base/data-buffer
 
+[@stdlib/ndarray/base/descriptor]: https://github.com/stdlib-js/ndarray/tree/main/base/descriptor
+
 [@stdlib/ndarray/base/diagonal]: https://github.com/stdlib-js/ndarray/tree/main/base/diagonal
 
 [@stdlib/ndarray/base/dtype-alignment]: https://github.com/stdlib-js/ndarray/tree/main/base/dtype-alignment