feat: add support for accessor arrays

Author: kgryte

lib/node_modules/@stdlib/array/base/cartesian-product/docs/types/index.d.ts

@@ -20,7 +20,7 @@
 
 /// <reference types="@stdlib/types"/>
 
-import { Collection } from '@stdlib/types/array';
+import { Collection, AccessorArrayLike } from '@stdlib/types/array';
 
 /**
 * Returns the Cartesian product.
@@ -40,7 +40,7 @@ import { Collection } from '@stdlib/types/array';
 * var out = cartesianProduct( x1, x2 );
 * // returns [ [ 1, 4 ], [ 1, 5 ], [ 2, 4 ], [ 2, 5 ], [ 3, 4 ], [ 3, 5 ] ]
 */
-declare function cartesianProduct<T = unknown, U = unknown>( x1: Collection<T>, x2: Collection<U> ): Array<[T, U]>;
+declare function cartesianProduct<T = unknown, U = unknown>( x1: Collection<T> | AccessorArrayLike<T>, x2: Collection<U> | AccessorArrayLike<U> ): Array<[T, U]>;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/array/base/cartesian-product/lib/main.js

@@ -18,6 +18,11 @@
 
 'use strict';
 
+// MODULES //
+
+var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
+
+
 // MAIN //
 
 /**
@@ -35,20 +40,25 @@
 * // returns [ [ 1, 4 ], [ 1, 5 ], [ 2, 4 ], [ 2, 5 ], [ 3, 4 ], [ 3, 5 ] ]
 */
 function cartesianProduct( x1, x2 ) {
+	var get1;
+	var get2;
 	var out;
 	var M;
 	var N;
 	var v;
 	var i;
 	var j;
 
+	get1 = resolveGetter( x1 );
+	get2 = resolveGetter( x2 );
+
 	M = x1.length;
 	N = x2.length;
 	out = [];
 	for ( i = 0; i < M; i++ ) {
-		v = x1[ i ];
+		v = get1( x1, i );
 		for ( j = 0; j < N; j++ ) {
-			out.push( [ v, x2[ j ] ] );
+			out.push( [ v, get2( x2, j ) ] );
 		}
 	}
 	return out;

lib/node_modules/@stdlib/array/base/cartesian-product/test/test.js

@@ -16,11 +16,14 @@
 * limitations under the License.
 */
 
+/* eslint-disable max-len */
+
 'use strict';
 
 // MODULES //
 
 var tape = require( 'tape' );
+var toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
 var cartesianProduct = require( './../lib' );
 
 
@@ -32,7 +35,7 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'the function returns the Cartesian product', function test( t ) {
+tape( 'the function returns the Cartesian product (indexed)', function test( t ) {
 	var expected;
 	var actual;
 
@@ -55,7 +58,30 @@ tape( 'the function returns the Cartesian product', function test( t ) {
 	t.end();
 });
 
-tape( 'the function returns an empty array if provided one or more empty arrays', function test( t ) {
+tape( 'the function returns the Cartesian product (accessors)', function test( t ) {
+	var expected;
+	var actual;
+
+	actual = cartesianProduct( toAccessorArray( [ 1, 2 ] ), toAccessorArray( [ 3, 4 ] ) );
+	expected = [ [ 1, 3 ], [ 1, 4 ], [ 2, 3 ], [ 2, 4 ] ];
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	actual = cartesianProduct( toAccessorArray( [ 1 ] ), toAccessorArray( [ 3, 4 ] ) );
+	expected = [ [ 1, 3 ], [ 1, 4 ] ];
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	actual = cartesianProduct( toAccessorArray( [ 1, 2 ] ), toAccessorArray( [ 3 ] ) );
+	expected = [ [ 1, 3 ], [ 2, 3 ] ];
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	actual = cartesianProduct( toAccessorArray( [ 1, 2 ] ), toAccessorArray( [ 3, 4, 5 ] ) );
+	expected = [ [ 1, 3 ], [ 1, 4 ], [ 1, 5 ], [ 2, 3 ], [ 2, 4 ], [ 2, 5 ] ];
+	t.deepEqual( actual, expected, 'returns expected value' );
+
+	t.end();
+});
+
+tape( 'the function returns an empty array if provided one or more empty arrays (indexed)', function test( t ) {
 	var actual;
 
 	actual = cartesianProduct( [], [] );
@@ -69,3 +95,18 @@ tape( 'the function returns an empty array if provided one or more empty arrays'
 
 	t.end();
 });
+
+tape( 'the function returns an empty array if provided one or more empty arrays (accessors)', function test( t ) {
+	var actual;
+
+	actual = cartesianProduct( toAccessorArray( [] ), toAccessorArray( [] ) );
+	t.deepEqual( actual, [], 'returns expected value' );
+
+	actual = cartesianProduct( toAccessorArray( [ 1, 2 ] ), toAccessorArray( [] ) );
+	t.deepEqual( actual, [], 'returns expected value' );
+
+	actual = cartesianProduct( toAccessorArray( [] ), toAccessorArray( [ 3, 4 ] ) );
+	t.deepEqual( actual, [], 'returns expected value' );
+
+	t.end();
+});