Auto-generated commit

Author: stdlib-bot

NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2022 The Stdlib Authors.

README.md

@@ -116,7 +116,7 @@ var arr = ndarray2array( buffer, shape, strides, offset, order );
 ```javascript
 var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
 var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
-var dicreteUniform = require( '@stdlib/random-base-discrete-uniform' );
+var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
 var ndarray2array = require( '@stdlib/ndarray-base-to-array' );
 
 // Create a data buffer:
@@ -143,7 +143,7 @@ console.log( 'Dims: %s', shape.join( 'x' ) );
 var arr;
 var j;
 for ( i = 0; i < 20; i++ ) {
-    j = dicreteUniform( 0, ndims-1 );
+    j = discreteUniform( 0, ndims-1 );
     strides[ j ] *= -1;
     offset = strides2offset( shape, strides );
 

examples/index.js

@@ -20,7 +20,7 @@
 
 var shape2strides = require( '@stdlib/ndarray-base-shape2strides' );
 var strides2offset = require( '@stdlib/ndarray-base-strides2offset' );
-var dicreteUniform = require( '@stdlib/random-base-discrete-uniform' );
+var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
 var ndarray2array = require( './../lib' );
 
 // Create a data buffer:
@@ -47,7 +47,7 @@ console.log( 'Dims: %s', shape.join( 'x' ) );
 var arr;
 var j;
 for ( i = 0; i < 20; i++ ) {
-	j = dicreteUniform( 0, ndims-1 );
+	j = discreteUniform( 0, ndims-1 );
 	strides[ j ] *= -1;
 	offset = strides2offset( shape, strides );
 

lib/main.js

@@ -20,6 +20,7 @@
 
 // MODULES //
 
+var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
 var recurse = require( './recurse.js' );
 
 
@@ -55,7 +56,7 @@ function ndarray2array( buffer, shape, strides, offset, order ) {
 			return [];
 		}
 	}
-	return recurse( buffer, shape, strides, offset, order, 0 );
+	return recurse( arraylike2object( buffer ), shape, strides, offset, order, 0 ); // eslint-disable-line max-len
 }
 
 

lib/recurse.js

@@ -24,31 +24,33 @@
 * Recursively converts an ndarray to a generic array.
 *
 * @private
-* @param {(ArrayLikeObject|TypedArray|Buffer)} buffer - data buffer
+* @param {Object} obj - array object
+* @param {(ArrayLikeObject|TypedArray|Buffer)} obj.data - data buffer
+* @param {Function} obj.getter - element accessor
 * @param {NonNegativeIntegerArray} shape - array shape
 * @param {IntegerArray} strides - array strides
 * @param {NonNegativeInteger} offset - index offset
 * @param {string} order - specifies whether an array is row-major (C-style) or column-major (Fortran-style)
 * @param {NonNegativeInteger} dim - dimension
 * @returns {(Array|Array<Array>)} output array
 */
-function recurse( buffer, shape, strides, offset, order, dim ) {
+function recurse( obj, shape, strides, offset, order, dim ) {
 	var stride;
 	var item;
 	var out;
 	var n;
 	var i;
 
 	if ( dim >= shape.length ) {
-		return buffer[ offset ];
+		return obj.getter( obj.data, offset );
 	}
 	out = [];
 
 	n = shape[ dim ];
 	stride = strides[ dim ];
 
 	for ( i = 0; i < n; i++ ) {
-		item = recurse( buffer, shape, strides, offset, order, dim+1 );
+		item = recurse( obj, shape, strides, offset, order, dim+1 );
 		out.push( item );
 		offset += stride;
 	}

package.json

@@ -37,12 +37,16 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
+    "@stdlib/array-base-arraylike2object": "^0.0.x",
     "@stdlib/types": "^0.0.x"
   },
   "devDependencies": {
+    "@stdlib/array-complex64": "^0.0.x",
     "@stdlib/assert-is-array": "^0.0.x",
     "@stdlib/assert-is-array-array": "^0.0.x",
     "@stdlib/bench": "^0.0.x",
+    "@stdlib/complex-imagf": "^0.0.x",
+    "@stdlib/complex-realf": "^0.0.x",
     "@stdlib/ndarray-base-numel": "^0.0.x",
     "@stdlib/ndarray-base-shape2strides": "^0.0.x",
     "@stdlib/ndarray-base-strides2offset": "^0.0.x",

test/test.js

@@ -22,6 +22,9 @@
 
 var tape = require( 'tape' );
 var isArray = require( '@stdlib/assert-is-array' );
+var Complex64Array = require( '@stdlib/array-complex64' );
+var realf = require( '@stdlib/complex-realf' );
+var imagf = require( '@stdlib/complex-imagf' );
 var ndarray2array = require( './../lib' );
 
 
@@ -71,6 +74,40 @@ tape( 'the function converts an ndarray buffer to a generic array (1d; order=row
 	t.end();
 });
 
+tape( 'the function converts an ndarray buffer to a generic array (1d; order=row-major; complex data type)', function test( t ) {
+	var strides;
+	var offset;
+	var buffer;
+	var order;
+	var shape;
+	var out;
+	var v;
+
+	buffer = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+	shape = [ 3 ];
+	order = 'row-major';
+	strides = [ -1 ];
+	offset = 2;
+
+	out = ndarray2array( buffer, shape, strides, offset, order );
+	t.strictEqual( isArray( out ), true, 'returns an array' );
+
+	v = out[ 0 ];
+	t.strictEqual( realf( v ), 5.0, 'returns expected value' );
+	t.strictEqual( imagf( v ), 6.0, 'returns expected value' );
+
+	v = out[ 1 ];
+	t.strictEqual( realf( v ), 3.0, 'returns expected value' );
+	t.strictEqual( imagf( v ), 4.0, 'returns expected value' );
+
+	v = out[ 2 ];
+	t.strictEqual( realf( v ), 1.0, 'returns expected value' );
+	t.strictEqual( imagf( v ), 2.0, 'returns expected value' );
+
+	t.end();
+});
+
 tape( 'the function converts an ndarray buffer to a generic array (1d; order=column-major)', function test( t ) {
 	var expected;
 	var strides;
@@ -95,6 +132,40 @@ tape( 'the function converts an ndarray buffer to a generic array (1d; order=col
 	t.end();
 });
 
+tape( 'the function converts an ndarray buffer to a generic array (1d; order=column-major; complex data type)', function test( t ) {
+	var strides;
+	var offset;
+	var buffer;
+	var order;
+	var shape;
+	var out;
+	var v;
+
+	buffer = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+	shape = [ 3 ];
+	order = 'column-major';
+	strides = [ 1 ];
+	offset = 0;
+
+	out = ndarray2array( buffer, shape, strides, offset, order );
+	t.strictEqual( isArray( out ), true, 'returns an array' );
+
+	v = out[ 0 ];
+	t.strictEqual( realf( v ), 1.0, 'returns expected value' );
+	t.strictEqual( imagf( v ), 2.0, 'returns expected value' );
+
+	v = out[ 1 ];
+	t.strictEqual( realf( v ), 3.0, 'returns expected value' );
+	t.strictEqual( imagf( v ), 4.0, 'returns expected value' );
+
+	v = out[ 2 ];
+	t.strictEqual( realf( v ), 5.0, 'returns expected value' );
+	t.strictEqual( imagf( v ), 6.0, 'returns expected value' );
+
+	t.end();
+});
+
 tape( 'the function converts an ndarray buffer to a generic array (2d; order=row-major)', function test( t ) {
 	var expected;
 	var strides;