feat: add array/cartesian-square

Author: kgryte

lib/node_modules/@stdlib/array/cartesian-square/README.md

@@ -0,0 +1,97 @@
+<!--
+
+@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.
+
+-->
+
+# cartesianSquare
+
+> Return the [Cartesian square][cartesian-product].
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cartesianSquare = require( '@stdlib/array/cartesian-square' );
+```
+
+#### cartesianSquare( x )
+
+Returns the [Cartesian square][cartesian-product].
+
+```javascript
+var x = [ 1, 2 ];
+
+var out = cartesianSquare( x );
+// returns [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]
+```
+
+If provided an empty array, the function returns an empty array.
+
+```javascript
+var out = cartesianSquare( [] );
+// returns []
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var linspace = require( '@stdlib/array/linspace' );
+var cartesianSquare = require( '@stdlib/array/cartesian-square' );
+
+var x = linspace( 0, 5, 6 );
+
+var out = cartesianSquare( x );
+// returns [ [ 0, 0 ], [ 0, 1 ], ..., [ 5, 4 ], [ 5, 5 ] ]
+```
+
+</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 -->

lib/node_modules/@stdlib/array/cartesian-square/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( '@stdlib/array/zero-to' );
+var pkg = require( './../package.json' ).name;
+var cartesianSquare = 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 = cartesianSquare( 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();
+});

lib/node_modules/@stdlib/array/cartesian-square/benchmark/benchmark.length.js

@@ -0,0 +1,95 @@
+/**
+* @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 cartesianSquare = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = discreteUniform( len, 0, 3 );
+	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 = cartesianSquare( 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();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 2^min
+	max = 10; // 2^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 2, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+(len*len), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/cartesian-square/docs/repl.txt

@@ -0,0 +1,24 @@
+
+{{alias}}( x )
+    Returns the Cartesian square.
+
+    If provided an empty array, the function returns an empty array.
+
+    Parameters
+    ----------
+    x: ArrayLikeObject
+        Input array.
+
+    Returns
+    -------
+    out: Array<Array>
+        Cartesian product.
+
+    Examples
+    --------
+    > var out = {{alias}}( [ 1, 2 ] )
+    [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]
+
+    See Also
+    --------
+

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

@@ -0,0 +1,46 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { Collection, AccessorArrayLike } from '@stdlib/types/array';
+
+/**
+* Returns the Cartesian square.
+*
+* ## Notes
+*
+* -   If provided an empty array, the function returns an empty array.
+*
+* @param x - input array
+* @returns Cartesian product
+*
+* @example
+* var x = [ 1, 2 ];
+*
+* var out = cartesianSquare( x );
+* // returns [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ]
+*/
+declare function cartesianSquare<T = unknown>( x: Collection<T> | AccessorArrayLike<T> ): Array<Array<T>>;
+
+
+// EXPORTS //
+
+export = cartesianSquare;

lib/node_modules/@stdlib/array/cartesian-square/docs/types/test.ts

@@ -0,0 +1,46 @@
+/*
+* @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.
+*/
+
+import cartesianSquare = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of arrays...
+{
+	cartesianSquare( [ 1, 2, 3, 4 ] ); // $ExpectType number[][]
+	cartesianSquare<number>( [ 1, 2, 3, 4 ] ); // $ExpectType number[][]
+	cartesianSquare<string>( [ '1', '2', '3', '4' ] ); // $ExpectType string[][]
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array-like object...
+{
+	cartesianSquare( 1 ); // $ExpectError
+	cartesianSquare( true ); // $ExpectError
+	cartesianSquare( false ); // $ExpectError
+	cartesianSquare( null ); // $ExpectError
+	cartesianSquare( void 0 ); // $ExpectError
+	cartesianSquare( {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	cartesianSquare(); // $ExpectError
+	cartesianSquare( [], [] ); // $ExpectError
+	cartesianSquare( [], [], [] ); // $ExpectError
+}

lib/node_modules/@stdlib/array/cartesian-square/examples/index.js

@@ -0,0 +1,28 @@
+/**
+* @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';
+
+var linspace = require( '@stdlib/array/linspace' );
+var cartesianSquare = require( './../lib' );
+
+var x = linspace( 0, 5, 6 );
+
+var out = cartesianSquare( x );
+console.log( out );
+// => [ [ 0, 0 ], [ 0, 1 ], ..., [ 5, 4 ], [ 5, 5 ] ]