Awesome
Cartesian product for big inputs.
Retrieves every possible combination between several arrays (cartesian product):
- can handle an infinite number of combinations
- requires almost no memory
This module is perfect when you combine hundreds of arrays or when those arrays
produce millions of combinations. Otherwise you should use
fast-cartesian
instead as it is
much faster.
Hire me
Please reach out if you're looking for a Node.js API or CLI engineer (11 years of experience). Most recently I have been Netlify Build's and Netlify Plugins' technical lead for 2.5 years. I am available for full-time remote positions.
Example
<!-- eslint-disable fp/no-loops -->import bigCartesian from 'big-cartesian'
for (const values of bigCartesian([
['red', 'blue'],
['circle', 'square'],
])) {
console.log(values)
}
// [ 'red', 'circle' ]
// [ 'red', 'square' ]
// [ 'blue', 'circle' ]
// [ 'blue', 'square' ]
Install
npm install big-cartesian
This package works in both Node.js >=18.18.0 and browsers.
This is an ES module. It must be loaded using
an import
or import()
statement,
not require()
. If TypeScript is used, it must be configured to
output ES modules,
not CommonJS.
API
bigCartesian(inputs)
inputs
: Array<Array | Iterable | GeneratorFunction>
Return value:
Iterable<Array>
Iterates over each combination of inputs
.
Limits
This works with an infinite number of combinations.
Arrays in JavaScript have a size limit of 4 trillions of elements. You can bypass this limit by using iterables or generator functions instead.
<!-- eslint-disable fp/no-loops -->import bigCartesian from 'big-cartesian'
const generator = function* () {
// This generator can generate an infinite number of elements
}
// Notice we pass the function itself: `generator` not `generator()`
for (const values of bigCartesian([['red', 'blue'], generator])) {
console.log(values)
}
Benchmarks
See the following benchmarks.
Support
For any question, don't hesitate to submit an issue on GitHub.
Everyone is welcome regardless of personal background. We enforce a Code of conduct in order to promote a positive and inclusive environment.
Contributing
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
If the documentation is unclear or has a typo, please click on the page's Edit
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our guidelines. Pull requests are welcome!
<!-- Thanks go to our wonderful contributors: --> <!-- ALL-CONTRIBUTORS-LIST:START --> <!-- prettier-ignore --> <!-- <table><tr><td align="center"><a href="https://fosstodon.org/@ehmicky"><img src="https://avatars2.githubusercontent.com/u/8136211?v=4" width="100px;" alt="ehmicky"/><br /><sub><b>ehmicky</b></sub></a><br /><a href="https://github.com/ehmicky/big-cartesian/commits?author=ehmicky" title="Code">💻</a> <a href="#design-ehmicky" title="Design">🎨</a> <a href="#ideas-ehmicky" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/ehmicky/big-cartesian/commits?author=ehmicky" title="Documentation">📖</a></td></tr></table> --> <!-- ALL-CONTRIBUTORS-LIST:END -->