Feature/iter cunone #2613

ruthwikchikoti · 2024-07-16T19:23:59Z

Resolves #2333.

Description

What is the purpose of this pull request?
This pull request:

Implements a new iterator function iterCuNone
Adds functionality to cumulatively test whether every iterated value is falsy
Enhances the stdlib iterator ecosystem

Related Issues

Does this pull request have any related issues?
This pull request:

resolves [RFC]: add @stdlib/iter/cunone #2333

Other

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

Takes an input iterator
Returns a new iterator that yields boolean values
Continues yielding true while all values are falsy
Yields false once a truthy value is encountered
Handles both iterable and non-iterable input iterators

Checklist

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

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

Implement iterCuNone to create an iterator which cumulatively tests whether every iterated value is falsy. This new function: - Takes an input iterator - Returns a new iterator that yields boolean values - Continues yielding while all values are falsy - Yields once a truthy value is encountered - Handles both iterable and non-iterable input iterators Includes: - Main implementation - TypeScript typings - Tests - Benchmarks - Example usage - Documentation Closes stdlib-js#2333

kgryte · 2024-07-16T22:55:31Z

lib/node_modules/@stdlib/iter/cunone/README.md

+## Usage
+
+```javascript
+var iterCuNone = require( '@stdlib/iter/cunone' );


This file is incomplete.

kgryte · 2024-07-16T22:57:02Z

lib/node_modules/@stdlib/iter/cunone/benchmark/benchmark.js

+    }
+    b.pass( 'benchmark finished' );
+    b.end();
+});


Make sure you have EditorConfig setup as documented in the dev guides.

kgryte · 2024-07-16T22:57:21Z

lib/node_modules/@stdlib/iter/cunone/docs/repl.txt

+    The returned iterator immediately returns `false` upon encountering a truthy
+    value, for all subsequent iterations.
+
+    If provided an iterator which does not return any iterated values, the


This isn't correct.

kgryte · 2024-07-16T23:00:30Z

lib/node_modules/@stdlib/iter/cunone/lib/main.js

+			return v;
+		}
+		if ( v.value ) {
+			FLG = true;


I don't think this is what we want. Once this is set, the iterator ends. We want the iterator to continue iterating so long as a source iterator has values.

Again, this is a cumulative iterator so the iterator should have the same length as the source iterator.

kgryte · 2024-07-16T23:01:31Z

lib/node_modules/@stdlib/iter/cunone/package.json

@@ -0,0 +1,85 @@
+{
+    "name": "@stdlib/iter-cunone",


Package name is incorrect.

@stdlib/iter/cunone
@kgryte

Yes, that is correct. You can confirm this by examining all other packages in the main project repository. In short, package names should match the directory path.

kgryte · 2024-07-16T23:01:58Z

lib/node_modules/@stdlib/iter/cunone/package.json

+    "bugs": {
+      "url": "https://github.com/stdlib-js/stdlib/issues"
+    },
+    "dependencies": {


Dependencies and dev deps should not be present.

kgryte · 2024-07-16T23:03:06Z

lib/node_modules/@stdlib/iter/cunone/lib/main.js

+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );


All these package names are incorrect. They should be names from the main project, not standalone pkg names. See other packages.

This applies here and elsewhere.

kgryte · 2024-07-16T23:04:22Z

lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/README.md

@@ -111,6 +111,76 @@ var objectKeys = require( '@stdlib/utils/keys' );
 var kumaraswamy = require( '@stdlib/stats/base/dists/kumaraswamy' );

 console.log( objectKeys( kumaraswamy ) );
+// Create a Kumaraswamy distribution object


These changes should not be present in this PR.

kgryte · 2024-07-16T23:04:31Z

lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/examples/index.js

@@ -22,3 +22,72 @@ var objectKeys = require( '@stdlib/utils/keys' );
 var kumaraswamy = require( './../lib' );

 console.log( objectKeys( kumaraswamy ) );
+// Create a Kumaraswamy distribution object


These changes should not be present in this PR.

Hey @kgryte, could you clarify if #1632 should be included here? Also, please review #1632 before I move on to #2613.

you are saying to remove #1632 right ? from this issue #2613

Correct. A PR should be focused on one thing. You are currently mixing both #1632 and #2613. This PR should only be concerned with #2613.

You can simply undo the Kumaraswamy changes in this PR, and this PR can be judged on its own merits, irrespective of #1632.

kgryte · 2024-07-17T09:32:27Z

@ruthwikchikoti Did you mean to close this? If you need to make changes, just do so on this PR.

ruthwikchikoti · 2024-07-17T10:06:48Z

@kgryte raising a new pr

ruthwikchikoti added 2 commits July 15, 2024 18:29

issue#1632 resolved

2786956

kgryte requested changes Jul 16, 2024

View reviewed changes

ruthwikchikoti closed this Jul 17, 2024

ruthwikchikoti deleted the feature/iter-cunone branch July 17, 2024 09:32

ruthwikchikoti restored the feature/iter-cunone branch July 17, 2024 09:32

ruthwikchikoti deleted the feature/iter-cunone branch July 17, 2024 09:32

ruthwikchikoti added a commit to ruthwikchikoti/stdlib that referenced this pull request Jul 17, 2024

stdlib-js#2613 resolved

25b9aad

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/iter cunone #2613

Feature/iter cunone #2613

ruthwikchikoti commented Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

ruthwikchikoti Jul 17, 2024 •

edited

Loading

kgryte Jul 17, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

kgryte Jul 16, 2024

ruthwikchikoti Jul 17, 2024

ruthwikchikoti Jul 17, 2024

kgryte Jul 17, 2024

kgryte Jul 17, 2024 •

edited

Loading

kgryte commented Jul 17, 2024

ruthwikchikoti commented Jul 17, 2024


		// MODULES //

		var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );

Feature/iter cunone #2613

Feature/iter cunone #2613

Conversation

ruthwikchikoti commented Jul 16, 2024

Description

Related Issues

Other

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ruthwikchikoti Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kgryte Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

kgryte commented Jul 17, 2024

ruthwikchikoti commented Jul 17, 2024

ruthwikchikoti Jul 17, 2024 •

edited

Loading

kgryte Jul 17, 2024 •

edited

Loading