cartesianProduct

Return the Cartesian product.

Installation

npm install @stdlib/array-cartesian-product

Usage

var cartesianProduct = require( '@stdlib/array-cartesian-product' );

cartesianProduct( x1, x2 )

Returns the Cartesian product.

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.

var x1 = [ 1, 2, 3, 4 ];
var x2 = [];

var out = cartesianProduct( x1, x2 );
// returns []

Examples

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

See Also

• @stdlib/array-cartesian-power: return the Cartesian power.
• @stdlib/array-cartesian-square: return the Cartesian square.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.