Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-12-31)
+## Unreleased (2025-01-01)
 
 <section class="packages">
 
@@ -86,6 +86,7 @@
 
 ##### Features
 
+-   [`33b46cb`](https://github.com/stdlib-js/stdlib/commit/33b46cbab14e25a72a7464d6d923f09a56ee0d44) - update namespace TypeScript declarations [(#4426)](https://github.com/stdlib-js/stdlib/pull/4426)
 -   [`1ddeba9`](https://github.com/stdlib-js/stdlib/commit/1ddeba98295bb53fb8098d1016f0de4b7f544e96) - add `scalar2ndarrayLike` to namespace
 -   [`58e795d`](https://github.com/stdlib-js/stdlib/commit/58e795db467b7bd1d3dc6c5847f91a97fed2ccff) - update namespace TypeScript declarations [(#3937)](https://github.com/stdlib-js/stdlib/pull/3937)
 -   [`14427c7`](https://github.com/stdlib-js/stdlib/commit/14427c79bc62f82b16cbadc9d34749901e48d105) - add `fill`, `map`, and `toReversed` to namespace
@@ -529,6 +530,9 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`8a15baa`](https://github.com/stdlib-js/stdlib/commit/8a15baa639e8c4f45479821cf7331715e0546e86) - **docs:** update related packages sections [(#4425)](https://github.com/stdlib-js/stdlib/pull/4425) _(by stdlib-bot)_
+-   [`33b46cb`](https://github.com/stdlib-js/stdlib/commit/33b46cbab14e25a72a7464d6d923f09a56ee0d44) - **feat:** update namespace TypeScript declarations [(#4426)](https://github.com/stdlib-js/stdlib/pull/4426) _(by stdlib-bot, Philipp Burckhardt)_
+-   [`edae311`](https://github.com/stdlib-js/stdlib/commit/edae3110b4b7cc1d675d44e211ffffcff77d6153) - **docs:** update namespace table of contents [(#4428)](https://github.com/stdlib-js/stdlib/pull/4428) _(by stdlib-bot, Philipp Burckhardt)_
 -   [`e4a53d5`](https://github.com/stdlib-js/stdlib/commit/e4a53d5816f5918f7c7fc5135dce21d676835eca) - **docs:** update related packages sections [(#4399)](https://github.com/stdlib-js/stdlib/pull/4399) _(by stdlib-bot)_
 -   [`259b682`](https://github.com/stdlib-js/stdlib/commit/259b682b2fb67d03e2987ca02b57d0cbc631ae8e) - **feat:** add support for specifying an array index cache and add support for linear indexing _(by Athan Reines)_
 -   [`1ddeba9`](https://github.com/stdlib-js/stdlib/commit/1ddeba98295bb53fb8098d1016f0de4b7f544e96) - **feat:** add `scalar2ndarrayLike` to namespace _(by Athan Reines)_

README.md

@@ -221,7 +221,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
 
 </section>
 

base/README.md

@@ -78,6 +78,7 @@ var o = ns;
 -   <span class="signature">[`fliplr( x, writable )`][@stdlib/ndarray/base/fliplr]</span><span class="delimiter">: </span><span class="description">return a view of an input ndarray in which the order of elements along the last dimension is reversed.</span>
 -   <span class="signature">[`flipud( x, writable )`][@stdlib/ndarray/base/flipud]</span><span class="delimiter">: </span><span class="description">return a view of an input ndarray in which the order of elements along the second-to-last dimension is reversed.</span>
 -   <span class="signature">[`forEach( arrays, fcn[, thisArg] )`][@stdlib/ndarray/base/for-each]</span><span class="delimiter">: </span><span class="description">invoke a callback function once for each ndarray element.</span>
+-   <span class="signature">[`scalar2ndarrayLike( x, value )`][@stdlib/ndarray/base/from-scalar-like]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray having the same data type as a provided ndarray.</span>
 -   <span class="signature">[`scalar2ndarray( value, dtype, order )`][@stdlib/ndarray/base/from-scalar]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray.</span>
 -   <span class="signature">[`ind( idx, max, mode )`][@stdlib/ndarray/base/ind]</span><span class="delimiter">: </span><span class="description">return an index given an index mode.</span>
 -   <span class="signature">[`ind2sub( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/ind2sub]</span><span class="delimiter">: </span><span class="description">convert a linear index to an array of subscripts.</span>
@@ -266,6 +267,8 @@ console.log( objectKeys( ns ) );
 
 [@stdlib/ndarray/base/for-each]: https://github.com/stdlib-js/ndarray/tree/main/base/for-each
 
+[@stdlib/ndarray/base/from-scalar-like]: https://github.com/stdlib-js/ndarray/tree/main/base/from-scalar-like
+
 [@stdlib/ndarray/base/from-scalar]: https://github.com/stdlib-js/ndarray/tree/main/base/from-scalar
 
 [@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/ndarray/tree/main/base/ind

base/docs/types/index.d.ts

@@ -57,6 +57,7 @@ import fliplr = require( './../../../base/fliplr' );
 import flipud = require( './../../../base/flipud' );
 import forEach = require( './../../../base/for-each' );
 import scalar2ndarray = require( './../../../base/from-scalar' );
+import scalar2ndarrayLike = require( './../../../base/from-scalar-like' );
 import ind = require( './../../../base/ind' );
 import ind2sub = require( './../../../base/ind2sub' );
 import iterationOrder = require( './../../../base/iteration-order' );
@@ -1143,6 +1144,33 @@ interface Namespace {
 	*/
 	scalar2ndarray: typeof scalar2ndarray;
 
+	/**
+	* Returns a zero-dimensional ndarray containing a provided scalar value and having the same data type as a provided input ndarray.
+	*
+	* @param x - input array
+	* @param value - scalar value
+	* @returns zero-dimensional ndarray
+	*
+	* @example
+	* var zeros = require( './../../../base/zeros' );
+	*
+	* var x = zeros( 'float64', [ 2, 2 ], 'row-major' );
+	* // returns <ndarray>
+	*
+	* var y = ns.scalar2ndarrayLike( x, 1.0 );
+	* // returns <ndarray>
+	*
+	* var sh = y.shape;
+	* // returns []
+	*
+	* var dt = y.dtype;
+	* // returns 'generic'
+	*
+	* var v = y.get();
+	* // returns 1.0
+	*/
+	scalar2ndarrayLike: typeof scalar2ndarrayLike;
+
 	/**
 	* Returns an index given an index mode.
 	*

map/README.md

@@ -239,6 +239,7 @@ console.log( ndarray2array( y ) );
 
 -   <span class="package-name">[`@stdlib/ndarray/filter`][@stdlib/ndarray/filter]</span><span class="delimiter">: </span><span class="description">return a shallow copy of an ndarray containing only those elements which pass a test implemented by a predicate function.</span>
 -   <span class="package-name">[`@stdlib/ndarray/filter-map`][@stdlib/ndarray/filter-map]</span><span class="delimiter">: </span><span class="description">filter and map elements in an input ndarray to elements in a new output ndarray according to a callback function.</span>
+-   <span class="package-name">[`@stdlib/ndarray/for-each`][@stdlib/ndarray/for-each]</span><span class="delimiter">: </span><span class="description">invoke a callback function once for each ndarray element.</span>
 -   <span class="package-name">[`@stdlib/ndarray/slice`][@stdlib/ndarray/slice]</span><span class="delimiter">: </span><span class="description">return a read-only view of an input ndarray.</span>
 
 </section>
@@ -259,6 +260,8 @@ console.log( ndarray2array( y ) );
 
 [@stdlib/ndarray/filter-map]: https://github.com/stdlib-js/ndarray/tree/main/filter-map
 
+[@stdlib/ndarray/for-each]: https://github.com/stdlib-js/ndarray/tree/main/for-each
+
 [@stdlib/ndarray/slice]: https://github.com/stdlib-js/ndarray/tree/main/slice
 
 <!-- </related-links> -->