Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -820,6 +820,9 @@ A total of 45 issues were closed in this release:
 
 <details>
 
+-   [`1a45821`](https://github.com/stdlib-js/stdlib/commit/1a458218a5e319ee00c0d3ddb4e065ad64edef4c) - **docs:** update examples to use accessor functions _(by Athan Reines)_
+-   [`e835a44`](https://github.com/stdlib-js/stdlib/commit/e835a4459def3255aa112790371508f6d9b7d16b) - **docs:** update examples to use accessor functions _(by Athan Reines)_
+-   [`887f9ca`](https://github.com/stdlib-js/stdlib/commit/887f9caca4ebe0bca507718b2f0ac26f063298c3) - **docs:** update examples and benchmarks _(by Athan Reines)_
 -   [`c13dd70`](https://github.com/stdlib-js/stdlib/commit/c13dd703daff4a5893dac860a78fe6e0631e68ec) - **refactor:** normalize dtypes to enums to reduce memory consumption and speed-up comparisons _(by Athan Reines)_
 -   [`2041e12`](https://github.com/stdlib-js/stdlib/commit/2041e12c968c4bd6f4a4f051271aacaa65727a6d) - **docs:** ensure support for dtype instances and update examples _(by Athan Reines)_
 -   [`88a7c4d`](https://github.com/stdlib-js/stdlib/commit/88a7c4de78c60740018a7038279248e48a2019cc) - **refactor:** add support for ancillary ndarray arguments having trailing dimensions _(by Athan Reines)_

base/to-array/README.md

@@ -105,14 +105,11 @@ var arr = ndarray2array( buffer, shape, strides, offset, order );
 var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
 var strides2offset = require( '@stdlib/ndarray/base/strides2offset' );
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
 var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
 
 // Create a data buffer:
-var buffer = [];
-var i;
-for ( i = 0; i < 27; i++ ) {
-    buffer.push( i );
-}
+var buffer = zeroTo( 27 );
 
 // Specify array meta data:
 var shape = [ 3, 3, 3 ];
@@ -129,6 +126,7 @@ console.log( 'Dims: %s', shape.join( 'x' ) );
 
 // Randomly flip strides and convert an ndarray to a nested array...
 var arr;
+var i;
 var j;
 for ( i = 0; i < 20; i++ ) {
     j = discreteUniform( 0, ndims-1 );

base/to-array/benchmark/benchmark.js

@@ -21,11 +21,11 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
 var isArrayArray = require( '@stdlib/assert/is-array-array' );
 var shape2strides = require( './../../../base/shape2strides' );
 var strides2offset = require( './../../../base/strides2offset' );
 var numel = require( './../../../base/numel' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
 var pkg = require( './../package.json' ).name;
 var ndarray2array = require( './../lib' );
 
@@ -47,15 +47,11 @@ bench( pkg+':order=row-major', function benchmark( b ) {
 	len = numel( shape );
 	strides = shape2strides( shape, order );
 	offset = strides2offset( shape, strides );
-
-	buffer = [];
-	for ( i = 0; i < len; i++ ) {
-		buffer.push( i );
-	}
+	buffer = zeroTo( len );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		strides[ 1 ] *= ( randu() < 0.5 ) ? -1 : 1;
+		strides[ 1 ] *= ( i%2 === 0 ) ? -1 : 1;
 		out = ndarray2array( buffer, shape, strides, offset, order );
 		if ( out.length !== shape[ 0 ] ) {
 			b.fail( 'should have expected length' );
@@ -87,15 +83,11 @@ bench( pkg+':order=column-major', function benchmark( b ) {
 	len = numel( shape );
 	strides = shape2strides( shape, order );
 	offset = strides2offset( shape, strides );
-
-	buffer = [];
-	for ( i = 0; i < len; i++ ) {
-		buffer.push( i );
-	}
+	buffer = zeroTo( len );
 
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		strides[ 1 ] *= ( randu() < 0.5 ) ? -1 : 1;
+		strides[ 1 ] *= ( i%2 === 0 ) ? -1 : 1;
 		out = ndarray2array( buffer, shape, strides, offset, order );
 		if ( out.length !== shape[ 0 ] ) {
 			b.fail( 'should have expected length' );

base/to-array/examples/index.js

@@ -21,14 +21,11 @@
 var shape2strides = require( './../../../base/shape2strides' );
 var strides2offset = require( './../../../base/strides2offset' );
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
 var ndarray2array = require( './../lib' );
 
 // Create a data buffer:
-var buffer = [];
-var i;
-for ( i = 0; i < 27; i++ ) {
-	buffer.push( i );
-}
+var buffer = zeroTo( 27 );
 
 // Specify array meta data:
 var shape = [ 3, 3, 3 ];
@@ -45,6 +42,7 @@ console.log( 'Dims: %s', shape.join( 'x' ) );
 
 // Randomly flip strides and convert an ndarray to a nested array...
 var arr;
+var i;
 var j;
 for ( i = 0; i < 20; i++ ) {
 	j = discreteUniform( 0, ndims-1 );

base/to-flippedlr/README.md

@@ -46,30 +46,24 @@ Returns a new ndarray where the order of elements along the last dimension of an
 
 ```javascript
 var ndarray = require( '@stdlib/ndarray/ctor' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var getShape = require( '@stdlib/ndarray/shape' );
 
 var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
 var shape = [ 3, 2 ];
 var strides = [ 2, 1 ];
 var offset = 0;
 
 var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-// returns <ndarray>
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 
-var sh = x.shape;
+var sh = getShape( x );
 // returns [ 3, 2 ]
 
-var arr = ndarray2array( x );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
-
 var y = toFlippedlr( x );
-// returns <ndarray>
+// returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 
-sh = y.shape;
+sh = getShape( y );
 // returns [ 3, 2 ]
-
-arr = ndarray2array( y );
-// returns [ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 ```
 
 The function accepts the following arguments:

base/to-flippedlr/docs/repl.txt

@@ -16,15 +16,9 @@
     Examples
     --------
     > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
-    <ndarray>
-    > x.shape
-    [ 2, 2 ]
+    <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
     > var y = {{alias}}( x )
-    <ndarray>
-    > y.shape
-    [ 2, 2 ]
-    > {{alias:@stdlib/ndarray/to-array}}( y )
-    [ [ 2, 1 ], [ 4, 3 ] ]
+    <ndarray>[ [ 2, 1 ], [ 4, 3 ] ]
 
     See Also
     --------

base/to-flippedlr/docs/types/index.d.ts

@@ -30,31 +30,25 @@ import { ndarray } from '@stdlib/types/ndarray';
 *
 * @example
 * var typedarray = require( '@stdlib/array/typed' );
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
 *
 * var buffer = typedarray( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], 'float64' );
 * var shape = [ 3, 2 ];
 * var strides = [ 2, 1 ];
 * var offset = 0;
 *
 * var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* var sh = x.shape;
+* var sh = getShape( x );
 * // returns [ 3, 2 ]
 *
-* var arr = ndarray2array( x );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
-*
 * var y = toFlippedlr( x );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 *
-* sh = y.shape;
+* sh = getShape( y );
 * // returns [ 3, 2 ]
-*
-* arr = ndarray2array( y );
-* // returns [ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 */
 declare function toFlippedlr<T extends ndarray>( x: T ): T;
 

base/to-flippedlr/lib/index.js

@@ -25,7 +25,7 @@
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
+* var getShape = require( '@stdlib/ndarray/shape' );
 * var toFlippedlr = require( '@stdlib/ndarray/base/to-flippedlr' );
 *
 * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
@@ -34,22 +34,16 @@
 * var offset = 0;
 *
 * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* var sh = x.shape;
+* var sh = getShape( x );
 * // returns [ 3, 2 ]
 *
-* var arr = ndarray2array( x );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
-*
 * var y = toFlippedlr( x );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 *
-* sh = y.shape;
+* sh = getShape( y );
 * // returns [ 3, 2 ]
-*
-* arr = ndarray2array( y );
-* // returns [ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 */
 
 // MODULES //

base/to-flippedlr/lib/main.js

@@ -36,30 +36,24 @@ var assign = require( './../../../base/assign' );
 *
 * @example
 * var ndarray = require( '@stdlib/ndarray/ctor' );
-* var ndarray2array = require( '@stdlib/ndarray/to-array' );
+* var getShape = require( '@stdlib/ndarray/shape' );
 *
 * var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
 * var shape = [ 3, 2 ];
 * var strides = [ 2, 1 ];
 * var offset = 0;
 *
 * var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 *
-* var sh = x.shape;
+* var sh = getShape( x );
 * // returns [ 3, 2 ]
 *
-* var arr = ndarray2array( x );
-* // returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
-*
 * var y = toFlippedlr( x );
-* // returns <ndarray>
+* // returns <ndarray>[ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 *
-* sh = y.shape;
+* sh = getShape( y );
 * // returns [ 3, 2 ]
-*
-* arr = ndarray2array( y );
-* // returns [ [ 2.0, 1.0 ], [ 4.0, 3.0 ], [ 6.0, 5.0 ] ]
 */
 function toFlippedlr( x ) {
 	var out;

base/to-flippedud/README.md

@@ -46,30 +46,24 @@ Returns a new ndarray where the order of elements along the second-to-last dimen
 
 ```javascript
 var ndarray = require( '@stdlib/ndarray/ctor' );
-var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var getShape = require( '@stdlib/ndarray/shape' );
 
 var buffer = [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ];
 var shape = [ 3, 2 ];
 var strides = [ 2, 1 ];
 var offset = 0;
 
 var x = ndarray( 'generic', buffer, shape, strides, offset, 'row-major' );
-// returns <ndarray>
+// returns <ndarray>[ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
 
-var sh = x.shape;
+var sh = getShape( x );
 // returns [ 3, 2 ]
 
-var arr = ndarray2array( x );
-// returns [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ]
-
 var y = toFlippedud( x );
-// returns <ndarray>
+// returns <ndarray>[ [ 5.0, 6.0 ], [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
 
-sh = y.shape;
+sh = getShape( y );
 // returns [ 3, 2 ]
-
-arr = ndarray2array( y );
-// returns [ [ 5.0, 6.0 ], [ 3.0, 4.0 ], [ 1.0, 2.0 ] ]
 ```
 
 The function accepts the following arguments: