Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -817,6 +817,7 @@ A total of 45 issues were closed in this release:
 
 <details>
 
+-   [`7ab721b`](https://github.com/stdlib-js/stdlib/commit/7ab721ba37db35ef62c6b658ba6ddeef4f8bff64) - **test:** use accessor functions for accessing ndarray meta data _(by Athan Reines)_
 -   [`1c769c9`](https://github.com/stdlib-js/stdlib/commit/1c769c983b0a4197ba30c9372568e03af00e9c00) - **test:** use accessors for retrieving ndarray meta data _(by Athan Reines)_
 -   [`06b39a8`](https://github.com/stdlib-js/stdlib/commit/06b39a8dce95540bd60183f40f7afe51a0affdc7) - **refactor:** update to accommodate dtype instances _(by Athan Reines)_
 -   [`ba129b3`](https://github.com/stdlib-js/stdlib/commit/ba129b35eed5099aece6caa686c3794e9a6b08b5) - **docs:** update namespace table of contents [(#11198)](https://github.com/stdlib-js/stdlib/pull/11198) _(by stdlib-bot)_

base/maybe-broadcast-arrays/README.md

@@ -91,34 +91,23 @@ var out = maybeBroadcastArrays( [ x, y ] );
 ```javascript
 var array = require( '@stdlib/ndarray/array' );
 var zeros = require( '@stdlib/ndarray/zeros' );
-var numel = require( '@stdlib/ndarray/base/numel' );
-var ind2sub = require( '@stdlib/ndarray/ind2sub' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
 var maybeBroadcastArrays = require( '@stdlib/ndarray/base/maybe-broadcast-arrays' );
 
 // Create a 2x2 array:
 var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-// returns <ndarray>
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 
 // Create a 3x2x2 array:
 var y = zeros( [ 3, 2, 2 ] );
 // returns <ndarray>
 
 // Broadcast arrays to a common shape:
 var out = maybeBroadcastArrays( [ x, y ] );
-// returns <ndarray>
-
-// Retrieve the common shape:
-var sh = out[ 0 ].shape;
-// returns [ 3, 2, 2 ]
-
-// Retrieve the number of elements:
-var N = numel( sh );
+// returns [ <ndarray>, <ndarray> ]
 
-// Loop through the array elements...
-var i;
-for ( i = 0; i < N; i++ ) {
-    console.log( 'X[%s] = %d', ind2sub( sh, i ).join( ', ' ), out[ 0 ].iget( i ) );
-}
+console.log( ndarray2array( out[ 0 ] ) );
+// => [ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 ```
 
 </section>

base/maybe-broadcast-arrays/docs/repl.txt

@@ -34,37 +34,15 @@
     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:@stdlib/ndarray/zeros}}( [ 3, 2, 2 ] )
-    <ndarray>
+    <ndarray>[ [ [0,0], [0,0] ], [ [0,0], [0,0] ], [ [0,0], [0,0] ] ]
     > var out = {{alias}}( [ x, y ] )
     [ <ndarray>, <ndarray> ]
 
     // Retrieve the broadcasted "x" array:
     > var bx = out[ 0 ]
-    <ndarray>
-    > sh = bx.shape
-    [ 3, 2, 2 ]
-
-    // Retrieve broadcasted elements...
-    > var v = bx.get( 0, 0, 0 )
-    1
-    > v = bx.get( 0, 0, 1 )
-    2
-    > v = bx.get( 0, 1, 0 )
-    3
-    > v = bx.get( 0, 1, 1 )
-    4
-    > v = bx.get( 1, 0, 0 )
-    1
-    > v = bx.get( 1, 1, 0 )
-    3
-    > v = bx.get( 2, 0, 0 )
-    1
-    > v = bx.get( 2, 1, 1 )
-    4
+    <ndarray>[ [ [1,2], [3,4] ], [ [1,2], [3,4] ], [ [1,2], [3,4] ] ]
 
     See Also
     --------

base/maybe-broadcast-arrays/docs/types/index.d.ts

@@ -38,53 +38,36 @@ import { ndarray } from '@stdlib/types/ndarray';
 * @returns list of broadcasted arrays
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 * var zeros = require( '@stdlib/ndarray/zeros' );
 *
-* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x.shape;
+* var shx = getShape( x1 );
 * // returns [ 2, 2 ]
 *
 * var y1 = zeros( [ 3, 2, 2 ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ] ]
 *
-* var shy = y1.shape;
+* var shy = getShape( y1 );
 * // returns [ 3, 2, 2 ]
 *
-* var out = maybeBroadcastArrays( [ x, y1 ] );
+* var out = maybeBroadcastArrays( [ x1, y1 ] );
 * // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 *
 * var y2 = out[ 1 ];
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ] ]
 *
-* shx = x2.shape;
+* shx = getShape( x2 );
 * // returns [ 3, 2, 2 ]
 *
-* shy = y2.shape;
+* shy = getShape( y2 );
 * // returns [ 3, 2, 2 ]
-*
-* var v = x2.get( 0, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 0, 0, 1 );
-* // returns 2
-*
-* v = x2.get( 1, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 1, 1, 0 );
-* // returns 3
-*
-* v = x2.get( 2, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 2, 1, 1 );
-* // returns 4
 */
 declare function maybeBroadcastArrays( arrays: ArrayLike<ndarray> ): Array<ndarray>;
 

base/maybe-broadcast-arrays/examples/index.js

@@ -20,8 +20,7 @@
 
 var array = require( './../../../array' );
 var zeros = require( './../../../zeros' );
-var numel = require( './../../../base/numel' );
-var ind2sub = require( './../../../ind2sub' );
+var ndarray2array = require( './../../../to-array' );
 var maybeBroadcastArrays = require( './../lib' );
 
 // Create a 2x2 array:
@@ -34,17 +33,6 @@ var y = zeros( [ 3, 2, 2 ] );
 
 // Broadcast arrays to a common shape:
 var out = maybeBroadcastArrays( [ x, y ] );
-// returns <ndarray>
-
-// Retrieve the common shape:
-var sh = out[ 0 ].shape;
-// returns [ 3, 2, 2 ]
-
-// Retrieve the number of elements:
-var N = numel( sh );
+// returns [ <ndarray>, <ndarray> ]
 
-// Loop through the array elements...
-var i;
-for ( i = 0; i < N; i++ ) {
-	console.log( 'X[%s] = %d', ind2sub( sh, i ).join( ', ' ), out[ 0 ].iget( i ) );
-}
+console.log( ndarray2array( out[ 0 ] ) );

base/maybe-broadcast-arrays/lib/index.js

@@ -24,54 +24,37 @@
 * @module @stdlib/ndarray/base/maybe-broadcast-arrays
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 * var zeros = require( '@stdlib/ndarray/zeros' );
 * var maybeBroadcastArrays = require( '@stdlib/ndarray/base/maybe-broadcast-arrays' );
 *
 * var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x1.shape;
+* var shx = getShape( x1 );
 * // returns [ 2, 2 ]
 *
 * var y1 = zeros( [ 3, 2, 2 ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ] ]
 *
-* var shy = y1.shape;
+* var shy = getShape( y1 );
 * // returns [ 3, 2, 2 ]
 *
 * var out = maybeBroadcastArrays( [ x1, y1 ] );
 * // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 *
 * var y2 = out[ 1 ];
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ] ]
 *
-* shx = x2.shape;
+* shx = getShape( x2 );
 * // returns [ 3, 2, 2 ]
 *
-* shy = y2.shape;
+* shy = getShape( y2 );
 * // returns [ 3, 2, 2 ]
-*
-* var v = x2.get( 0, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 0, 0, 1 );
-* // returns 2
-*
-* v = x2.get( 1, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 1, 1, 0 );
-* // returns 3
-*
-* v = x2.get( 2, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 2, 1, 1 );
-* // returns 4
 */
 
 // MODULES //

base/maybe-broadcast-arrays/lib/main.js

@@ -40,54 +40,37 @@ var getShape = require( './../../../base/shape' );
 * @returns {Array<ndarray>} broadcasted arrays
 *
 * @example
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var array = require( '@stdlib/ndarray/array' );
 * var zeros = require( '@stdlib/ndarray/zeros' );
 *
 * var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
 *
-* var shx = x1.shape;
+* var shx = getShape( x1 );
 * // returns [ 2, 2 ]
 *
 * var y1 = zeros( [ 3, 2, 2 ] );
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ] ]
 *
-* var shy = y1.shape;
+* var shy = getShape( y1 );
 * // returns [ 3, 2, 2 ]
 *
 * var out = maybeBroadcastArrays( [ x1, y1 ] );
-* // returns <ndarray>
+* // returns [ <ndarray>, <ndarray> ]
 *
 * var x2 = out[ 0 ];
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ], [ [ 1, 2 ], [ 3, 4 ] ] ]
 *
 * var y2 = out[ 1 ];
-* // returns <ndarray>
+* // returns <ndarray>[ [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ], [ [ 0, 0 ], [ 0, 0 ] ] ]
 *
-* shx = x2.shape;
+* shx = getShape( x2 );
 * // returns [ 3, 2, 2 ]
 *
-* shy = y2.shape;
+* shy = getShape( y2 );
 * // returns [ 3, 2, 2 ]
 *
-* var v = x2.get( 0, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 0, 0, 1 );
-* // returns 2
-*
-* v = x2.get( 1, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 1, 1, 0 );
-* // returns 3
-*
-* v = x2.get( 2, 0, 0 );
-* // returns 1
-*
-* v = x2.get( 2, 1, 1 );
-* // returns 4
-*
 * @example
 * var zeros = require( '@stdlib/ndarray/zeros' );
 *