Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Features
 
+-   [`8f8998f`](https://github.com/stdlib-js/stdlib/commit/8f8998f02831c2db69698a26769916d68acfe54f) - update `ndarray/base` TypeScript declarations [(#9913)](https://github.com/stdlib-js/stdlib/pull/9913)
 -   [`b6d8bcc`](https://github.com/stdlib-js/stdlib/commit/b6d8bcc8e3a285d4f874748191904580321aa0e8) - add `quinaryLoopOrder` to namespace
 -   [`f3a6bc0`](https://github.com/stdlib-js/stdlib/commit/f3a6bc070f6ac5e2dee1374534ba6b0c134e4db6) - add `quaternaryLoopOrder` to namespace
 -   [`02b9b76`](https://github.com/stdlib-js/stdlib/commit/02b9b7662449c9a04917e1353a8b53ff85df45d4) - add `broadcastScalarLike` to namespace
@@ -720,6 +721,7 @@ A total of 43 issues were closed in this release:
 
 <details>
 
+-   [`8f8998f`](https://github.com/stdlib-js/stdlib/commit/8f8998f02831c2db69698a26769916d68acfe54f) - **feat:** update `ndarray/base` TypeScript declarations [(#9913)](https://github.com/stdlib-js/stdlib/pull/9913) _(by stdlib-bot)_
 -   [`196734e`](https://github.com/stdlib-js/stdlib/commit/196734eccb0d43439332b2a275fb3a50cb73df67) - **docs:** update namespace table of contents [(#9915)](https://github.com/stdlib-js/stdlib/pull/9915) _(by stdlib-bot)_
 -   [`b6d8bcc`](https://github.com/stdlib-js/stdlib/commit/b6d8bcc8e3a285d4f874748191904580321aa0e8) - **feat:** add `quinaryLoopOrder` to namespace _(by Athan Reines)_
 -   [`f3a6bc0`](https://github.com/stdlib-js/stdlib/commit/f3a6bc070f6ac5e2dee1374534ba6b0c134e4db6) - **feat:** add `quaternaryLoopOrder` to namespace _(by Athan Reines)_

base/docs/types/index.d.ts

@@ -36,6 +36,7 @@ import broadcastArray = require( './../../../base/broadcast-array' );
 import broadcastArrayExceptDimensions = require( './../../../base/broadcast-array-except-dimensions' );
 import broadcastArrays = require( './../../../base/broadcast-arrays' );
 import broadcastScalar = require( './../../../base/broadcast-scalar' );
+import broadcastScalarLike = require( './../../../base/broadcast-scalar-like' );
 import broadcastShapes = require( './../../../base/broadcast-shapes' );
 import buffer = require( './../../../base/buffer' );
 import bufferCtors = require( './../../../base/buffer-ctors' );
@@ -124,6 +125,8 @@ import outputPolicyStr2Enum = require( './../../../base/output-policy-str2enum'
 import pop = require( './../../../base/pop' );
 import prependSingletonDimensions = require( './../../../base/prepend-singleton-dimensions' );
 import promoteDataTypes = require( './../../../base/promote-dtypes' );
+import quaternaryLoopOrder = require( './../../../base/quaternary-loop-interchange-order' );
+import quinaryLoopOrder = require( './../../../base/quinary-loop-interchange-order' );
 import removeSingletonDimensions = require( './../../../base/remove-singleton-dimensions' );
 import reverse = require( './../../../base/reverse' );
 import reverseDimension = require( './../../../base/reverse-dimension' );
@@ -745,6 +748,28 @@ interface Namespace {
 	*/
 	broadcastScalar: typeof broadcastScalar;
 
+	/**
+	* Broadcasts a scalar value to an ndarray having the same shape and data type as a provided input ndarray.
+	*
+	* @param x - input array
+	* @param value - scalar value
+	* @returns output ndarray
+	*
+	* @example
+	* var zeros = require( './../../../base/zeros' );
+	* var getDType = require( './../../../dtype' );
+	*
+	* var x = zeros( 'float64', [ 2, 2 ], 'row-major' );
+	* // returns <ndarray>[ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ]
+	*
+	* var y = ns.broadcastScalarLike( x, 1.0 );
+	* // returns <ndarray>[ [ 1.0, 1.0 ], [ 1.0, 1.0 ] ]
+	*
+	* var dt = String( getDType( y ) );
+	* // returns 'float64'
+	*/
+	broadcastScalarLike: typeof broadcastScalarLike;
+
 	/**
 	* Broadcasts array shapes to a single shape.
 	*
@@ -3194,6 +3219,136 @@ interface Namespace {
 	*/
 	promoteDataTypes: typeof promoteDataTypes;
 
+	/**
+	* Reorders ndarray dimensions and associated strides for loop interchange.
+	*
+	* ## Notes
+	*
+	* -   The returned object has the following properties:
+	*
+	*     -   **sh**: dimensions sorted in loop order.
+	*     -   **sx**: first input ndarray strides sorted in loop order.
+	*     -   **sy**: second input ndarray strides sorted in loop order.
+	*     -   **sz**: third input ndarray strides sorted in loop order.
+	*     -   **sw**: fourth input ndarray strides sorted in loop order.
+	*     -   **su**: output ndarray strides sorted in loop order.
+	*
+	* -   When iterating over the elements of a multi-dimensional array, accessing elements which are closer in memory can improve performance. To this end, loop interchange is a technique used in loop nest optimization to improve locality of reference and take advantage of CPU cache.
+	*
+	*     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.
+	*
+	* -   Cache performance may be degraded if the layout order (i.e., row-major or column-major) differs for the input and output ndarrays. This function is intended to optimize cache performance for the most common layout order. Accordingly, if the output ndarray has a different layout order (e.g., if the input ndarrays are row-major and the output ndarray is column-major), cache misses are likely for the output ndarray. In general, to ensure best performance, input and output ndarrays should have the same layout order.
+	*
+	* -   The function assumes that the input and output ndarrays have the same shape. Hence, loop interchange order should only be determined **after** broadcasting.
+	*
+	* @param shape - array dimensions
+	* @param stridesX - first input array stride lengths
+	* @param stridesY - second input array stride lengths
+	* @param stridesZ - third input array stride lengths
+	* @param stridesW - fourth input array stride lengths
+	* @param stridesU - output array stride lengths
+	* @returns loop interchange data
+	*
+	* @example
+	* var sh = [ 2, 3, 4 ];
+	*
+	* var sx = [ 12, 4, 1 ]; // row-major
+	* var sy = [ 24, 8, 1 ]; // row-major
+	* var sz = [ 1, 4, 12 ]; // column-major
+	* var sw = [ 1, -2, 6 ]; // column-major
+	* var su = [ 1, -2, 6 ]; // column-major
+	*
+	* var o = ns.quaternaryLoopOrder( sh, sx, sy, sz, sw, su );
+	* // returns {...}
+	*
+	* var ssh = o.sh;
+	* // returns [ 2, 3, 4 ]
+	*
+	* var ssx = o.sx;
+	* // returns [ 12, 4, 1 ]
+	*
+	* var ssy = o.sy;
+	* // returns [ 24, 8, 1 ]
+	*
+	* var ssz = o.sz;
+	* // returns [ 1, 4, 12 ]
+	*
+	* var ssw = o.sw;
+	* // returns [ 1, -2, 6 ]
+	*
+	* var ssu = o.su;
+	* // returns [ 1, -2, 6 ]
+	*/
+	quaternaryLoopOrder: typeof quaternaryLoopOrder;
+
+	/**
+	* Reorders ndarray dimensions and associated strides for loop interchange.
+	*
+	* ## Notes
+	*
+	* -   The returned object has the following properties:
+	*
+	*     -   **sh**: dimensions sorted in loop order.
+	*     -   **sx**: first input ndarray strides sorted in loop order.
+	*     -   **sy**: second input ndarray strides sorted in loop order.
+	*     -   **sz**: third input ndarray strides sorted in loop order.
+	*     -   **sw**: fourth input ndarray strides sorted in loop order.
+	*     -   **su**: fifth input ndarray strides sorted in loop order.
+	*     -   **sv**: output ndarray strides sorted in loop order.
+	*
+	* -   When iterating over the elements of a multi-dimensional array, accessing elements which are closer in memory can improve performance. To this end, loop interchange is a technique used in loop nest optimization to improve locality of reference and take advantage of CPU cache.
+	*
+	*     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.
+	*
+	* -   Cache performance may be degraded if the layout order (i.e., row-major or column-major) differs for the input and output ndarrays. This function is intended to optimize cache performance for the most common layout order. Accordingly, if the output ndarray has a different layout order (e.g., if the input ndarrays are row-major and the output ndarray is column-major), cache misses are likely for the output ndarray. In general, to ensure best performance, input and output ndarrays should have the same layout order.
+	*
+	* -   The function assumes that the input and output ndarrays have the same shape. Hence, loop interchange order should only be determined **after** broadcasting.
+	*
+	* @param shape - array dimensions
+	* @param stridesX - first input array stride lengths
+	* @param stridesY - second input array stride lengths
+	* @param stridesZ - third input array stride lengths
+	* @param stridesW - fourth input array stride lengths
+	* @param stridesU - fifth input array stride lengths
+	* @param stridesV - output array stride lengths
+	* @returns loop interchange data
+	*
+	* @example
+	* var sh = [ 2, 3, 4 ];
+	*
+	* var sx = [ 12, 4, 1 ]; // row-major
+	* var sy = [ 24, 8, 1 ]; // row-major
+	* var sz = [ 12, 4, 1 ]; // row-major
+	* var sw = [ 24, 8, 1 ]; // row-major
+	* var su = [ 1, 4, 12 ]; // column-major
+	* var sv = [ 1, -2, 6 ]; // column-major
+	*
+	* var o = ns.quinaryLoopOrder( sh, sx, sy, sz, sw, su, sv );
+	* // returns {...}
+	*
+	* var ssh = o.sh;
+	* // returns [ 4, 3, 2 ]
+	*
+	* var ssx = o.sx;
+	* // returns [ 1, 4, 12 ]
+	*
+	* var ssy = o.sy;
+	* // returns [ 1, 8, 24 ]
+	*
+	* var ssz = o.sz;
+	* // returns [ 1, 4, 12 ]
+	*
+	* var ssw = o.sw;
+	* // returns [ 1, 8, 24 ]
+	*
+	* var ssu = o.su;
+	* // returns [ 12, 4, 1 ]
+	*
+	* var ssv = o.sv;
+	* // returns [ 6, -2, 1 ]
+	*/
+	quinaryLoopOrder: typeof quinaryLoopOrder;
+
 	/**
 	* Returns an array without singleton dimensions.
 	*