feat: add `iter/cusome-by` #2661

vivek-anand-singh · 2024-07-25T14:40:53Z

Resolves #2338

Description

What is the purpose of this pull request?
The purpose of this pull request is to introduce the @stdlib/iter/cusome-by package, which provides a transform iterator to determine if at least n values from a source iterator satisfy a given predicate function. This new feature enhances the library by allowing cumulative testing of iterated values.

This pull request:

adds the feature of cusome-by function for stdib

Related Issues

Does this pull request have any related issues?

No

This pull request:

resolves [RFC]: add @stdlib/iter/cusome-by #2338
fixes [RFC]: add @stdlib/iter/cusome-by #2338

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.

No.

stdlib-bot

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

vivek-anand-singh · 2024-07-25T14:41:52Z

@kgryte Please review this PR .

kgryte · 2024-07-28T23:56:38Z

lib/node_modules/@stdlib/iter/cusome-by/README.MD

+Here's the adapted README.md for `cusome-by`, based on the `some-by` version:
+
+```markdown


This is not how to write README files. Furthermore, the README name is incorrect. We don't uppercase MD.

kgryte · 2024-07-28T23:57:28Z

lib/node_modules/@stdlib/iter/cusome-by/README.MD

+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/iter/cuany-by`][@stdlib/iter/cuany-by]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively applies a test function to iterated values, returning `true` if a test is passed and `false` otherwise.</span>
+-   <span class="package-name">[`@stdlib/iter/cuevery-by`][@stdlib/iter/cuevery-by]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively applies a test function to iterated values, returning `false` if a test fails and `true` otherwise.</span>
+-   <span class="package-name">[`@stdlib/iter/for-each`][@stdlib/iter/for-each]</span><span class="delimiter">: </span><span class="description">create an iterator which invokes a function for each iterated value before returning the iterated value.</span>
+-   <span class="package-name">[`@stdlib/iter/cunone-by`][@stdlib/iter/cunone-by]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively applies a test function to iterated values, returning `true` if all values fail and `false` otherwise.</span>
+-   <span class="package-name">[`@stdlib/iter/cusome`][@stdlib/iter/cusome]</span><span class="delimiter">: </span><span class="description">create an iterator which iteratively checks whether at least `n` iterated values are truthy.</span>


Do not manually edit this section. See the comment at L197. This section should be empty.

kgryte · 2024-07-28T23:57:41Z

lib/node_modules/@stdlib/iter/cusome-by/README.MD

+<!-- <related-links> -->
+
+[@stdlib/iter/cuany-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/cuany-by
+
+[@stdlib/iter/cuevery-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/cuevery-by
+
+[@stdlib/iter/for-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/for-each
+
+[@stdlib/iter/cunone-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/cunone-by
+
+[@stdlib/iter/cusome]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/cusome
+
+<!-- </related-links> -->


These should be removed.

kgryte · 2024-07-28T23:58:13Z

lib/node_modules/@stdlib/iter/cusome-by/benchmark/benchmark.js

+	function predicate( v ) {
+		return ( v > 0 );
+	}
+});


You did not setup EditorConfig. Please read our contributing guidelines.

kgryte · 2024-07-28T23:58:36Z

lib/node_modules/@stdlib/iter/cusome-by/docs/repl.txt

@@ -0,0 +1,49 @@
+The predicate function is provided two arguments:


This file does not adhere to project conventions. See the REPL text guide in /docs.

kgryte · 2024-07-28T23:59:46Z

lib/node_modules/@stdlib/iter/cusome-by/docs/types/index.d.ts

+/**
+* Interface for the returned iterator.
+*/
+interface CuSomeByIterator extends Iterator {


Why are you doing this? Use TypedIterator from @stdlib/types/iter. Furthermore, if the source iterator is iterable, the returned iterable should also be iterable. See other @stdlib/iter/* packages.

kgryte · 2024-07-29T00:00:09Z

lib/node_modules/@stdlib/iter/cusome-by/docs/types/test.ts

@@ -0,0 +1,106 @@
+import iterCuSomeBy = require( './index' );


Missing license header. Incorrect indentation throughout the file.

kgryte · 2024-07-29T00:00:36Z

lib/node_modules/@stdlib/iter/cusome-by/docs/types/test.ts

+
+
+


Why do you have multiple trailing lines?

kgryte · 2024-07-29T00:00:47Z

lib/node_modules/@stdlib/iter/cusome-by/examples/index.js

+		break;
+	}
+	console.log( v.value );
+}


EditorConfig.

kgryte · 2024-07-29T00:01:00Z

lib/node_modules/@stdlib/iter/cusome-by/lib/index.js

+
+// EXPORTS //
+
+module.exports = main;


EditorConfig.

kgryte · 2024-07-29T00:02:10Z

lib/node_modules/@stdlib/iter/cusome-by/lib/main.js

+			return {
+				'value': false,
+				'done': false
+			};


Suggested change

return {

'value': false,

'done': false

};

return v;

kgryte · 2024-07-29T00:02:21Z

lib/node_modules/@stdlib/iter/cusome-by/lib/main.js

+
+// EXPORTS //
+
+module.exports = iterCuSomeBy;


EditorConfig.

kgryte · 2024-07-29T00:02:47Z

lib/node_modules/@stdlib/iter/cusome-by/package.json

@@ -0,0 +1,73 @@
+{
+    "name": "@stdlib/iter/cusome-by",


Indentation in this file is off.

kgryte · 2024-07-29T00:02:59Z

lib/node_modules/@stdlib/iter/cusome-by/package.json

+      "cusome",
+      "transform"
+    ]
+  }


EditorConfig.

kgryte · 2024-07-29T00:03:26Z

lib/node_modules/@stdlib/iter/cusome-by/test/test.js

+tape( 'the function returns an iterator', function test( t ) {
+	var it = iterCuSomeBy( array2iterator( [ 1, 1, 0, 0, 1 ] ), 3, predicate );
+	t.equal( typeof it.next, 'function', 'has next method' );
+	// t.equal( typeof it.return, 'function', 'has return method' );


Don't leave commented code.

kgryte · 2024-07-29T00:03:32Z

lib/node_modules/@stdlib/iter/cusome-by/test/test.js

+
+	it = iterCuSomeBy( array2iterator( values ), 2, predicate );
+	t.equal( typeof it.next, 'function', 'has next method' );
+	// t.equal( typeof it.return, 'function', 'has return method' );


Same thing.

kgryte · 2024-07-29T00:03:58Z

lib/node_modules/@stdlib/iter/cusome-by/test/test.js

+	t.equal( typeof r.value, 'boolean', 'returns a boolean' );
+	t.equal( r.done, false, 'returns expected value' );
+
+	// r = it.return();


Why did you do this? Now the test does not test what it is supposed to.

kgryte · 2024-07-29T00:04:06Z

lib/node_modules/@stdlib/iter/cusome-by/test/test.js

+	t.equal( typeof r.value, 'boolean', 'returns a boolean' );
+	t.equal( r.done, false, 'returns expected value' );
+
+	// r = it.return( 'finished' );


Same thing.

kgryte · 2024-07-29T00:04:22Z

lib/node_modules/@stdlib/iter/cusome-by/test/test.js

+		this.count += 1; // eslint-disable-line no-invalid-this
+		return ( v > 0 );
+	}
+});


EditorConfig.

kgryte · 2024-07-29T00:05:11Z

yarn.lock

Why did you include this file? Remove.

kgryte

This PR needs significant changes before it can be considered for further review. Please study existing packages in @stdlib/iter/* and emulate the style and conventions as closely as possible and as appropriate. And further, please be sure to setup your local dev environment for contributing to stdlib as discussed in the contributing guidelines. It is clear that linting was not setup locally.

kgryte · 2024-07-29T00:07:57Z

@vivek-anand-singh Also, in your OP, you removed the checkbox indicating that you have read the contributing guidelines. Without that checkbox, we cannot accept your PR. Please be sure to include that before any further review.

vivek-anand-singh added 4 commits July 25, 2024 18:26

Created the folder structure for cusome by

5c2ddc1

Benchmark

3777e1d

Resolved the logics and completed lib

2d8123c

Updated docs and changed main.js

2e1622a

stdlib-bot reviewed Jul 25, 2024

View reviewed changes

vivek-anand-singh mentioned this pull request Jul 27, 2024

feat: Added C implementation for @stdlib/math/base/special/fibonacci-index #2673

Closed

1 task

kgryte reviewed Jul 28, 2024

View reviewed changes