Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`e98a2a0`](https://github.com/stdlib-js/stdlib/commit/e98a2a0ffd29fe7da7a95ac18b4a1e519464fde0) - update `ndarray/base` TypeScript declarations [(#12688)](https://github.com/stdlib-js/stdlib/pull/12688)
 -   [`c016f87`](https://github.com/stdlib-js/stdlib/commit/c016f877831218b06cb925732a4f33612b58d5f8) - add `assignDiagonal` to namespace
 -   [`b186702`](https://github.com/stdlib-js/stdlib/commit/b186702222b3b2cd2039d886b62ce78bd2f6af3b) - add `ndarray/base/assign-diagonal` [(#11993)](https://github.com/stdlib-js/stdlib/pull/11993)
 -   [`e08276d`](https://github.com/stdlib-js/stdlib/commit/e08276d789ba1671769175bf5d2c3c5f587f6dca) - update `ndarray` TypeScript declarations [(#12593)](https://github.com/stdlib-js/stdlib/pull/12593)
@@ -36,6 +37,7 @@
 
 <details>
 
+-   [`e98a2a0`](https://github.com/stdlib-js/stdlib/commit/e98a2a0ffd29fe7da7a95ac18b4a1e519464fde0) - **feat:** update `ndarray/base` TypeScript declarations [(#12688)](https://github.com/stdlib-js/stdlib/pull/12688) _(by stdlib-bot)_
 -   [`8060cfe`](https://github.com/stdlib-js/stdlib/commit/8060cfed800ae155e24fd1298e1a6c7462dcc3ec) - **docs:** update `ndarray` TypeScript declarations [(#12689)](https://github.com/stdlib-js/stdlib/pull/12689) _(by stdlib-bot)_
 -   [`c016f87`](https://github.com/stdlib-js/stdlib/commit/c016f877831218b06cb925732a4f33612b58d5f8) - **feat:** add `assignDiagonal` to namespace _(by Athan Reines)_
 -   [`b186702`](https://github.com/stdlib-js/stdlib/commit/b186702222b3b2cd2039d886b62ce78bd2f6af3b) - **feat:** add `ndarray/base/assign-diagonal` [(#11993)](https://github.com/stdlib-js/stdlib/pull/11993) _(by Muhammad Haris, Athan Reines)_

base/docs/types/index.d.ts

@@ -25,6 +25,7 @@ import anyBy = require( './../../../base/any-by' );
 import appendSingletonDimensions = require( './../../../base/append-singleton-dimensions' );
 import assert = require( './../../../base/assert' );
 import assign = require( './../../../base/assign' );
+import assignDiagonal = require( './../../../base/assign-diagonal' );
 import assignScalar = require( './../../../base/assign-scalar' );
 import atleast1d = require( './../../../base/atleast1d' );
 import atleast2d = require( './../../../base/atleast2d' );
@@ -364,6 +365,39 @@ interface Namespace {
 	*/
 	assign: typeof assign;
 
+	/**
+	* Assigns elements from a broadcasted input ndarray to a specified diagonal of an output ndarray.
+	*
+	* ## Notes
+	*
+	* -   The order of the dimension indices contained in `dims` matters. The first element specifies the row-like dimension. The second element specifies the column-like dimension.
+	* -   Each provided dimension index must reside on the interval `[-ndims, ndims-1]`.
+	* -   The diagonal offset `k` is interpreted as `column - row`. Accordingly, when `k = 0`, the function assigns to the main diagonal; when `k > 0`, the function assigns to a diagonal above the main diagonal; and when `k < 0`, the function assigns to a diagonal below the main diagonal.
+	* -   The input ndarray must be broadcast compatible with the output ndarray view defined by the specified diagonal.
+	*
+	* @param arrays - array-like object containing one input array and one output array
+	* @param dims - dimension indices defining the plane in which to assign elements to the diagonal
+	* @param k - diagonal offset
+	* @returns output ndarray
+	*
+	* @example
+	* var scalar2ndarray = require( './../../../from-scalar' );
+	* var zeros = require( './../../../zeros' );
+	*
+	* var x = scalar2ndarray( 1.0 );
+	* // returns <ndarray>
+	*
+	* var y = zeros( [ 3, 3 ] );
+	* // returns <ndarray>[ [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ], [ 0.0, 0.0, 0.0 ] ]
+	*
+	* var out = ns.assignDiagonal( [ x, y ], [ 0, 1 ], 0 );
+	* // returns <ndarray>[ [ 1.0, 0.0, 0.0 ], [ 0.0, 1.0, 0.0 ], [ 0.0, 0.0, 1.0 ] ]
+	*
+	* var bool = ( out === y );
+	* // returns true
+	*/
+	assignDiagonal: typeof assignDiagonal;
+
 	/**
 	* Assigns a scalar value to every element of an output ndarray.
 	*
@@ -3351,8 +3385,8 @@ interface Namespace {
 	*
 	*     The purpose of this function is to order ndarray dimensions according to the magnitude of array strides. By using the ordered dimensions and associated strides, one can construct nested loops (one for each dimension) such that the innermost loop iterates over the dimension in which array elements are closest in memory and the outermost loop iterates over the dimension in which array elements are farthest apart in memory. As a consequence, element iteration is optimized to minimize cache misses and ensure locality of reference.
 	*
-	* @param sh - array dimensions
-	* @param sx - array stride lengths
+	* @param shape - array dimensions
+	* @param stridesX - array stride lengths
 	* @returns loop interchange data
 	*
 	* @example