Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/big-cartesian
Cartesian product for big inputs
https://github.com/ehmicky/big-cartesian
algorithm cartesian cartesian-product cartesian-products combinations combinatorics data-structures es6 functional functional-programming iterable javascript library lodash lodash-fp nodejs performance product sets typescript
Last synced: 19 days ago
JSON representation
Cartesian product for big inputs
- Host: GitHub
- URL: https://github.com/ehmicky/big-cartesian
- Owner: ehmicky
- License: apache-2.0
- Created: 2019-08-29T11:50:11.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:52:55.000Z (2 months ago)
- Last Synced: 2024-10-11T10:17:05.037Z (about 1 month ago)
- Topics: algorithm, cartesian, cartesian-product, cartesian-products, combinations, combinatorics, data-structures, es6, functional, functional-programming, iterable, javascript, library, lodash, lodash-fp, nodejs, performance, product, sets, typescript
- Language: TypeScript
- Homepage:
- Size: 6.08 MB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/big-cartesian)
[](https://unpkg.com/big-cartesian?module)
[](/src/main.ts)
[](https://codecov.io/gh/ehmicky/big-cartesian)
[](https://bundlephobia.com/package/big-cartesian)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Cartesian product for big inputs.
Retrieves every possible combination between several arrays
([cartesian product](https://en.wikipedia.org/wiki/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`](https://github.com/ehmicky/fast-cartesian) instead as it is
much faster.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Example
```js
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](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## bigCartesian(inputs)
`inputs`: `Array`\
_Return value_:
[`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols)
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.
```js
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](https://github.com/ehmicky/fast-cartesian#benchmarks).
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) 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](CONTRIBUTING.md). Pull requests are welcome!