Auto-generated commit

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 //

base/cartesian-product/lib/main.js

@@ -18,6 +18,11 @@
 
 'use strict';
 
+// MODULES //
+
+var resolveGetter = require( './../../../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;

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( './../../../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();
+});

cartesian-product/README.md

@@ -0,0 +1,102 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# cartesianProduct
+
+> Return the [Cartesian product][cartesian-product].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cartesianProduct = require( '@stdlib/array/cartesian-product' );
+```
+
+#### cartesianProduct( x1, x2 )
+
+Returns the [Cartesian product][cartesian-product].
+
+```javascript
+var x1 = [ 1, 2, 3 ];
+var x2 = [ 4, 5 ];
+
+var out = cartesianProduct( x1, x2 );
+// returns [ [ 1, 4 ], [ 1, 5 ], [ 2, 4 ], [ 2, 5 ], [ 3, 4 ], [ 3, 5 ] ]
+```
+
+If provided one or more empty arrays, the function returns an empty array.
+
+```javascript
+var x1 = [ 1, 2, 3, 4 ];
+var x2 = [];
+
+var out = cartesianProduct( x1, x2 );
+// returns []
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var linspace = require( '@stdlib/array/linspace' );
+var cartesianProduct = require( '@stdlib/array/cartesian-product' );
+
+var x1 = linspace( 0, 5, 6 );
+var x2 = linspace( 10, 15, 6 );
+
+var out = cartesianProduct( x1, x2 );
+// returns [ [ 0, 10 ], [ 0, 11 ], ..., [ 5, 14 ], [ 5, 15 ] ]
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product
+
+</section>
+
+<!-- /.links -->

cartesian-product/benchmark/benchmark.js

@@ -0,0 +1,52 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isArrayArray = require( '@stdlib/assert/is-array-array' );
+var zeroTo = require( './../../zero-to' );
+var pkg = require( './../package.json' ).name;
+var cartesianProduct = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':len=100', function benchmark( b ) {
+	var x;
+	var i;
+	var v;
+
+	x = zeroTo( 10 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = cartesianProduct( x, x );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array' );
+		}
+	}
+	b.toc();
+	if ( !isArrayArray( v ) ) {
+		b.fail( 'should return an array of arrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

cartesian-product/benchmark/benchmark.length.js

@@ -0,0 +1,96 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var isArrayArray = require( '@stdlib/assert/is-array-array' );
+var pkg = require( './../package.json' ).name;
+var cartesianProduct = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = discreteUniform( len/2, 0, 3 );
+	var y = [ 1, 2 ];
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = cartesianProduct( x, y );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an array' );
+			}
+		}
+		b.toc();
+		if ( !isArrayArray( v ) ) {
+			b.fail( 'should return an array of arrays' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();