Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/array-base-cartesian-product

Return the Cartesian product.
https://github.com/stdlib-js/array-base-cartesian-product

array cartesian generic javascript math mathematics node node-js nodejs ordered sets stdlib utilities utils

Last synced: 4 days ago
JSON representation

Return the Cartesian product.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# cartesianProduct



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Return the [Cartesian product][cartesian-product].



## Installation



```bash

npm install @stdlib/array-base-cartesian-product

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var cartesianProduct = require( '@stdlib/array-base-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 []

```



## Examples



```javascript

var linspace = require( '@stdlib/array-base-linspace' );

var cartesianProduct = require( '@stdlib/array-base-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 ] ]

```



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-cartesian-product.svg

[npm-url]: https://npmjs.org/package/@stdlib/array-base-cartesian-product



[test-image]: https://github.com/stdlib-js/array-base-cartesian-product/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/array-base-cartesian-product/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-cartesian-product/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/array-base-cartesian-product?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/array-base-cartesian-product/tree/deno

[deno-readme]: https://github.com/stdlib-js/array-base-cartesian-product/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/array-base-cartesian-product/tree/umd

[umd-readme]: https://github.com/stdlib-js/array-base-cartesian-product/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/array-base-cartesian-product/tree/esm

[esm-readme]: https://github.com/stdlib-js/array-base-cartesian-product/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/array-base-cartesian-product/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-cartesian-product/main/LICENSE



[cartesian-product]: https://en.wikipedia.org/wiki/Cartesian_product