feat: add `iter/cartesian-product` #1399

shubhexists · 2024-02-27T14:27:04Z

Resolves #1335

Description

What is the purpose of this pull request?

This pull request:

Adds implementation of iterator equivalent of cartesian-product

Related Issues

Does this pull request have any related issues?

#1335

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

TESTS

BENCHMARKS

EXAMPLES

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

maniksharma17 · 2024-02-27T18:59:14Z

@shubhexists hey, I cannot seem to run benchmark.js on the feat I added (@stdlib/utils/parse-ndjson) #1394 . I'm getting this error. I have debug in node_modules as well as in package.json. Did you encounter it too?

steff456

Hi @shubhexists, thanks for opening this PR!

I left some comments in this PR to get this approved, please let me know if you have any further question about any of them :)

lib/node_modules/@stdlib/iter/cartesian-product/README.md

steff456 · 2024-02-28T18:58:12Z

lib/node_modules/@stdlib/iter/cartesian-product/docs/types/test.ts

+	iterCartesianProduct( [ 1, 2, 3 ], [ 4, 5, 6 ] ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a first argument which is not array-like...


Please add a case for string, boolean, null and undefined to both arguments.

This is not resolved yet, I meant we need to add the case for these dtypes for the error cases rather than the correct case

This is still not resolved

lib/node_modules/@stdlib/iter/cartesian-product/examples/index.js

lib/node_modules/@stdlib/iter/cartesian-product/lib/main.js

lib/node_modules/@stdlib/iter/cartesian-product/test/test.js

shubhexists · 2024-02-28T21:52:43Z

Hi @steff456 , my idea of using linspace and zeroTo was that the iterCartesianProduct function takes in an Array instead of an Iterator, as mentioned in the Issue.
Since, randu returns an Iterator object, I would eventually have to run a while loop to collect all it's values into an Array.

What are your opinions?

steff456 · 2024-03-06T19:28:56Z

@shubhexists you are right, let's leave the examples with linspace

steff456

Thanks for the changes @shubhexists, there are still a couple of tiny fixes before this PR is ready!

steff456 · 2024-03-06T19:32:00Z

lib/node_modules/@stdlib/iter/cartesian-product/docs/types/test.ts

+	iterCartesianProduct( [ 1, 2, 3 ], [ 4, 5, 6 ] ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a first argument which is not array-like...


This is not resolved yet, I meant we need to add the case for these dtypes for the error cases rather than the correct case

lib/node_modules/@stdlib/iter/cartesian-product/test/test.js

Co-authored-by: Stephannie Jimenez Gacha <steff456@users.noreply.github.com> Signed-off-by: Shubham <shubh622005@gmail.com>

shubhexists · 2024-03-06T20:39:38Z

@steff456 Kindly have a look now

steff456

There's still a minor change for this PR to be ready.

steff456 · 2024-03-12T20:14:24Z

lib/node_modules/@stdlib/iter/cartesian-product/docs/types/test.ts

+	iterCartesianProduct( [ 1, 2, 3 ], [ 4, 5, 6 ] ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a first argument which is not array-like...


This is still not resolved

steff456 · 2024-03-12T20:16:31Z

lib/node_modules/@stdlib/iter/cartesian-product/docs/types/test.ts

+	iterCartesianProduct( 2, [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( false, [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( true, [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( {}, [ 4, 5, 6 ] ); // $ExpectError


The previous comment meant to add cases where the first argument is string, boolean, null and undefined

Suggested change

iterCartesianProduct( {}, [ 4, 5, 6 ] ); // $ExpectError

iterCartesianProduct( {}, [ 4, 5, 6 ] ); // $ExpectError

iterCartesianProduct( 'a', [ 4, 5, 6 ] ); // $ExpectError

iterCartesianProduct( null, [ 4, 5, 6 ] ); // $ExpectError

iterCartesianProduct( undefined, [ 4, 5, 6 ] ); // $ExpectError

Please do the same for the other test cases.

feat: add @stdlib/iter/cartesian-product

d7ca701

shubhexists mentioned this pull request Feb 27, 2024

feat: add utils/parse-ndjson #1394

Merged

1 task

steff456 self-requested a review February 28, 2024 18:20

steff456 suggested changes Feb 28, 2024

View reviewed changes

shubhexists added 4 commits February 29, 2024 02:39

feat: added space before parenthesis, removed benchmark.length.js

061e26d

feat: new benchmark added

16d7e16

feat: corrected readme according to iter packages

2903e7d

feat: updated doc test

26d7776

shubhexists requested a review from steff456 February 29, 2024 15:43

Planeshifter changed the title ~~feat: add @stdlib/iter/cartesian-product~~ feat: add iter/cartesian-product Mar 3, 2024

steff456 suggested changes Mar 6, 2024

View reviewed changes

steff456 added JavaScript Issue involves or relates to JavaScript. Needs Changes Pull request which needs changes before being merged. labels Mar 6, 2024

shubhexists and others added 3 commits March 7, 2024 01:44

Update lib/node_modules/@stdlib/iter/cartesian-product/test/test.js

61854c4

Co-authored-by: Stephannie Jimenez Gacha <steff456@users.noreply.github.com> Signed-off-by: Shubham <shubh622005@gmail.com>

Merge branch 'stdlib-js:develop' into develop

4eb651f

feat: fixed tests and lint

1b69049

steff456 suggested changes Mar 12, 2024

View reviewed changes

kgryte added Feature Issue or pull request for adding a new feature. Utilities Issue or pull request concerning general utilities. and removed JavaScript Issue involves or relates to JavaScript. labels Mar 20, 2024

shubhexists closed this by deleting the head repository Aug 31, 2024

-	iterCartesianProduct( {}, [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( {}, [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( 'a', [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( null, [ 4, 5, 6 ] ); // $ExpectError
+	iterCartesianProduct( undefined, [ 4, 5, 6 ] ); // $ExpectError

Uh oh!

feat: add iter/cartesian-product #1399

feat: add iter/cartesian-product #1399

Uh oh!

Conversation

shubhexists commented Feb 27, 2024

Description

Related Issues

Questions

Other

Checklist

Uh oh!

maniksharma17 commented Feb 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

steff456 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

steff456 Feb 28, 2024

Choose a reason for hiding this comment

Uh oh!

steff456 Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

steff456 Mar 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shubhexists commented Feb 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

steff456 commented Mar 6, 2024

Uh oh!

steff456 left a comment

Choose a reason for hiding this comment

Uh oh!

steff456 Mar 6, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shubhexists commented Mar 6, 2024

Uh oh!

steff456 left a comment

Choose a reason for hiding this comment

Uh oh!

steff456 Mar 12, 2024

Choose a reason for hiding this comment

Uh oh!

steff456 Mar 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

feat: add `iter/cartesian-product` #1399

feat: add `iter/cartesian-product` #1399

maniksharma17 commented Feb 27, 2024 •

edited

Loading

shubhexists commented Feb 28, 2024 •

edited

Loading