@stdlib/array-base-n-cartesian-product
v0.2.2
Published
Return the n-fold Cartesian product.
Downloads
125
Readme
nCartesianProduct
Return the n-fold Cartesian product.
Installation
npm install @stdlib/array-base-n-cartesian-product
Usage
var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' );
nCartesianProduct( x1, x2[, ...xN] )
Returns the n-fold Cartesian product.
var x1 = [ 1, 2, 3 ];
var x2 = [ 4, 5 ];
var out = nCartesianProduct( 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 = nCartesianProduct( x1, x2 );
// returns []
Examples
var linspace = require( '@stdlib/array-base-linspace' );
var nCartesianProduct = require( '@stdlib/array-base-n-cartesian-product' );
var x1 = linspace( 0, 5, 6 );
var x2 = linspace( 10, 15, 6 );
var x3 = linspace( 20, 25, 6 );
var out = nCartesianProduct( x1, x2, x3 );
// returns [ [ 0, 10, 20 ], [ 0, 10, 21 ], ... ]
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.