[RFC]: add @stdlib/iter/cartesian-product

[kgryte]

Description

This RFC proposes adding the package @stdlib/iter/cartesian-product.

This package would be the iterator equivalent of @stdlib/array/cartesian-product.

function iterCartesianProduct( x1, x2 ) { ... }

where x1 and x2 are input array-like objects.

Package: @stdlib/iter/cartesian-product
Alias: iterCartesianProduct

Related Issues

None.

Questions

No.

Other

No.

Checklist

• I have read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• The issue name begins with RFC:.

[Aryann15]

Hello! I'd like to work on this issue, Please assign it to me.
Thank you.

[kgryte]

Thanks for volunteering to work on this issue @Aryann15. Please feel free to submit a PR implementing this feature.

[Aryann15]

I wanted to seek clarification regarding the process of adding the @stdlib/iter/cartesian-product package to our project,

Based on my understanding of the issue description, the goal is to incorporate the iterator equivalent of @stdlib/array/cartesian-product into our project. Specifically, we aim to introduce the iterCartesianProduct(x1, x2) function, which generates an iterator over the Cartesian product of two input array-like objects, x1 and x2.

To accomplish this task, I've outlined the steps I plan to take:

I intend to install the @stdlib/iter/cartesian-product package using npm or yarn. I will run the following command in our project directory:
npm install @stdlib/iter/cartesian-product

After installing the package, I will import it into the relevant file or module where we plan to utilize the iterCartesianProduct function.
const iterCartesianProduct = require('@stdlib/iter/cartesian-product');

With the package imported, I will proceed to use the iterCartesianProduct function in our codebase. I will provide appropriate array-like objects (x1 and x2) as input to generate iterators over their Cartesian product.

Example:
const x1 = [1, 2, 3];
const x2 = ['a', 'b', 'c'];
const iterator = iterCartesianProduct(x1, x2);
for (const product of iterator) {
console.log(product);
}

I would greatly appreciate your feedback on whether this approach aligns with our project requirements and if any adjustments or additional considerations are necessary.
Thank you!

[kgryte]

@Aryann15 The approach you outline is not correct. See https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter for example iterator packages. You should only develop against the main project repository. There is no need to install standalone packages as you mention in your comment.

[shubhexists]

Hi Aryan, Are you currently proceeding with the issue? If not, I would like to give it a try.