Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -2,6 +2,40 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2026-03-29)
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`1c769c9`](https://github.com/stdlib-js/stdlib/commit/1c769c983b0a4197ba30c9372568e03af00e9c00) - **test:** use accessors for retrieving ndarray meta data _(by Athan Reines)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 1 person contributed to this release. Thank you to this contributor:
+
+-   Athan Reines
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.2.5">
 
 ## 0.2.5 (2026-02-08)

CHANGELOG.md

@@ -80,13 +80,13 @@ Broadcasts an [ndarray][@stdlib/ndarray/base/ctor] to a specified `shape` if and
 ```javascript
 var array = require( '@stdlib/ndarray-array' );
 
-// Create a 2x2 ndarray:
-var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-// returns <ndarray>
+// Create a 1x2 ndarray:
+var x = array( [ [ 1, 2 ] ] );
+// returns <ndarray>[ [ 1, 2 ] ]
 
 // Broadcast to a 2x2x2 ndarray:
 var y = maybeBroadcastArray( x, [ 2, 2, 2 ] );
-// returns <ndarray>
+// returns <ndarray>[ [ [ 1, 2 ], [ 1, 2 ] ], [ [ 1, 2 ], [ 1, 2 ] ] ]
 ```
 
 </section>
@@ -118,30 +118,16 @@ var y = maybeBroadcastArray( x, [ 2, 2, 2 ] );
 
 ```javascript
 var array = require( '@stdlib/ndarray-array' );
-var numel = require( '@stdlib/ndarray-base-numel' );
-var ind2sub = require( '@stdlib/ndarray-ind2sub' );
+var ndarray2array = require( '@stdlib/ndarray-to-array' );
 var maybeBroadcastArray = require( '@stdlib/ndarray-base-maybe-broadcast-array' );
 
 // Create a 2x2 array:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-// returns <ndarray>
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
 // Broadcast the array to 3x2x2:
 var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );
-// returns <ndarray>
-
-// Retrieve the shape:
-var sh = y.shape;
-// returns [ 3, 2, 2 ]
-
-// Retrieve the number of elements:
-var N = numel( sh );
-
-// Loop through the array elements...
-var i;
-for ( i = 0; i < N; i++ ) {
-    console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) );
-}
+// returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 ```
 
 </section>

README.md

@@ -39,29 +39,9 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
-    <ndarray>
-    > var sh = x.shape
-    [ 2, 2 ]
+    <ndarray>[ [1,2], [3,4] ]
     > var y = {{alias}}( x, [ 3, 2, 2 ] )
-    <ndarray>
-    > sh = y.shape
-    [ 3, 2, 2 ]
-    > var v = y.get( 0, 0, 0 )
-    1
-    > v = y.get( 0, 0, 1 )
-    2
-    > v = y.get( 0, 1, 0 )
-    3
-    > v = y.get( 0, 1, 1 )
-    4
-    > v = y.get( 1, 0, 0 )
-    1
-    > v = y.get( 1, 1, 0 )
-    3
-    > v = y.get( 2, 0, 0 )
-    1
-    > v = y.get( 2, 1, 1 )
-    4
+    <ndarray>[ [ [1,2], [3,4] ], [ [1,2], [3,4] ], [ [1,2], [3,4] ] ]
 
     See Also
     --------

dist/index.js.map

@@ -41,39 +41,22 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @returns broadcasted array
 *
 * @example
+* var getShape = require( '@stdlib/ndarray-shape' );
 * var array = require( '@stdlib/ndarray-array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 3, 2, 2 ]
-*
-* var v = y.get( 0, 0, 0 );
-* // returns 1
-*
-* v = y.get( 0, 0, 1 );
-* // returns 2
-*
-* v = y.get( 1, 0, 0 );
-* // returns 1
-*
-* v = y.get( 1, 1, 0 );
-* // returns 3
-*
-* v = y.get( 2, 0, 0 );
-* // returns 1
-*
-* v = y.get( 2, 1, 1 );
-* // returns 4
 */
-declare function maybeBroadcastArray( arr: ndarray, shape: ArrayLike<number> ): ndarray;
+declare function maybeBroadcastArray<T extends ndarray>( arr: T, shape: ArrayLike<number> ): T;
 
 
 // EXPORTS //

docs/repl.txt

@@ -16,46 +16,23 @@
 * limitations under the License.
 */
 
+/* eslint-disable space-in-parens */
+
 /// <reference types="@stdlib/types"/>
 
-import { ndarray } from '@stdlib/types/ndarray';
+import zeros = require( '@stdlib/ndarray-zeros' );
 import maybeBroadcastArray = require( './index' );
 
-/**
-* Mock function to create an ndarray-like object.
-*
-* @returns ndarray-like object
-*/
-function array(): ndarray {
-	const obj: ndarray = {
-		'byteLength': 80,
-		'BYTES_PER_ELEMENT': 8,
-		'data': new Float64Array( 10 ),
-		'dtype': 'float64',
-		'flags': {
-			'ROW_MAJOR_CONTIGUOUS': true,
-			'COLUMN_MAJOR_CONTIGUOUS': false
-		},
-		'length': 10,
-		'ndims': 1,
-		'offset': 0,
-		'order': 'row-major',
-		'shape': [ 10 ],
-		'strides': [ 1 ],
-		'get': (): number => 0,
-		'set': (): ndarray => obj
-	};
-	return obj;
-}
-
 
 // TESTS //
 
 // The function returns an ndarray...
 {
-	const x = array();
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
-	maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType ndarray
+	maybeBroadcastArray( x, [ 2, 2, 2 ] ); // $ExpectType float64ndarray
 }
 
 // The compiler throws an error if the function is not provided a first argument which is an ndarray...
@@ -72,7 +49,9 @@ function array(): ndarray {
 
 // The compiler throws an error if the function is not provided a second argument which is an array-like object containing numbers...
 {
-	const x = array();
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
 	maybeBroadcastArray( x, '5' ); // $ExpectError
 	maybeBroadcastArray( x, 5 ); // $ExpectError
@@ -86,7 +65,9 @@ function array(): ndarray {
 
 // The compiler throws an error if the function is provided an unsupported number of arguments...
 {
-	const x = array();
+	const x = zeros( [ 2, 2 ], {
+		'dtype': 'float64'
+	});
 
 	maybeBroadcastArray(); // $ExpectError
 	maybeBroadcastArray( x ); // $ExpectError

docs/types/index.d.ts

@@ -19,27 +19,13 @@
 'use strict';
 
 var array = require( '@stdlib/ndarray-array' );
-var numel = require( '@stdlib/ndarray-base-numel' );
-var ind2sub = require( '@stdlib/ndarray-ind2sub' );
+var ndarray2array = require( '@stdlib/ndarray-to-array' );
 var maybeBroadcastArray = require( './../lib' );
 
 // Create a 2x2 array:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-// returns <ndarray>
+console.log( ndarray2array( x ) );
 
 // Broadcast the array to 3x2x2:
 var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );
-// returns <ndarray>
-
-// Retrieve the shape:
-var sh = y.shape;
-// returns [ 3, 2, 2 ]
-
-// Retrieve the number of elements:
-var N = numel( sh );
-
-// Loop through the array elements...
-var i;
-for ( i = 0; i < N; i++ ) {
-	console.log( 'Y[%s] = %d', ind2sub( sh, i ).join( ', ' ), y.iget( i ) );
-}
+console.log( ndarray2array( y ) );

docs/types/test.ts

@@ -24,38 +24,21 @@
 * @module @stdlib/ndarray-base-maybe-broadcast-array
 *
 * @example
+* var getShape = require( '@stdlib/ndarray-shape' );
 * var array = require( '@stdlib/ndarray-array' );
 * var maybeBroadcastArray = require( '@stdlib/ndarray-base-maybe-broadcast-array' );
 *
 * var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x.shape;
+* var shx = getShape( x );
 * // returns [ 2, 2 ]
 *
 * var y = maybeBroadcastArray( x, [ 3, 2, 2 ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 *
-* var shy = y.shape;
+* var shy = getShape( y );
 * // returns [ 3, 2, 2 ]
-*
-* var v = y.get( 0, 0, 0 );
-* // returns 1
-*
-* v = y.get( 0, 0, 1 );
-* // returns 2
-*
-* v = y.get( 1, 0, 0 );
-* // returns 1
-*
-* v = y.get( 1, 1, 0 );
-* // returns 3
-*
-* v = y.get( 2, 0, 0 );
-* // returns 1
-*
-* v = y.get( 2, 1, 1 );
-* // returns 4
 */
 
 // MODULES //