feat: add iter/cuevery

PR-URL: #2955
Closes: #2332

Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

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

@@ -0,0 +1,159 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# iterCuEvery
+
+> Create an [iterator][mdn-iterator-protocol] which cumulatively tests whether every iterated value is truthy.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var iterCuEvery = require( '@stdlib/iter/cuevery' );
+```
+
+#### iterCuEvery( iterator )
+
+Returns an [iterator][mdn-iterator-protocol] which cumulatively tests whether every iterated value is truthy.
+
+```javascript
+var array2iterator = require( '@stdlib/array/to-iterator' );
+
+var arr = array2iterator( [ 1, 1, 1, 0, 1 ] );
+
+var it = iterCuEvery( arr );
+// returns <Object>
+
+var v = it.next().value;
+// returns true
+
+v = it.next().value;
+// returns true
+
+v = it.next().value;
+// returns true
+
+v = it.next().value;
+// returns false
+
+v = it.next().value;
+// returns false
+
+var bool = it.next().done;
+// returns true
+```
+
+The returned [iterator][mdn-iterator-protocol] protocol-compliant object has the following properties:
+
+- **next**: function which returns an [iterator][mdn-iterator-protocol] protocol-compliant object containing the next iterated value (if one exists) assigned to a `value` property and a `done` property having a `boolean` value indicating whether the [iterator][mdn-iterator-protocol] is finished.
+- **return**: function which closes an [iterator][mdn-iterator-protocol] and returns a single (optional) argument in an [iterator][mdn-iterator-protocol] protocol-compliant object.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/iter/randu' );
+var iterMap = require( '@stdlib/iter/map' );
+var iterCuEvery = require( '@stdlib/iter/cuevery' );
+
+function threshold( r ) {
+ return ( r > 0.1 );
+}
+
+// Create an iterator which generates uniformly distributed pseudorandom numbers:
+var opts = {
+ 'iter': 100
+};
+var riter = randu( opts );
+
+// Create an iterator which applies a threshold to generated numbers:
+var miter = iterMap( riter, threshold );
+
+// Create an iterator which cumulatively tests whether every iterated value is truthy:
+var it = iterCuEvery( miter );
+
+// Perform manual iteration...
+var r;
+while ( true ) {
+ r = it.next();
+ if ( r.done ) {
+ break;
+ }
+ console.log( r.value );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,75 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var iterConstant = require( '@stdlib/iter/constant' );
+var isIteratorLike = require( '@stdlib/assert/is-iterator-like' );
+var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var pkg = require( './../package.json' ).name;
+var iterCuEvery = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+ var iter;
+ var it;
+ var i;
+
+ it = iterConstant( 3.14 );
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ iter = iterCuEvery( it );
+ if ( typeof iter !== 'object' ) {
+ b.fail( 'should return an object' );
+ }
+ }
+ b.toc();
+ if ( !isIteratorLike( iter ) ) {
+ b.fail( 'should return an iterator protocol-compliant object' );
+ }
+ b.pass( 'benchmark finished' );
+ b.end();
+});
+
+bench( pkg+'::iteration', function benchmark( b ) {
+ var iter;
+ var v;
+ var i;
+
+ iter = iterCuEvery( iterConstant( 3.14 ) );
+
+ b.tic();
+ for ( i = 0; i < b.iterations; i++ ) {
+ v = iter.next().value;
+ if ( !isBoolean( v ) ) {
+ b.fail( 'should return a boolean' );
+ }
+ }
+ b.toc();
+ if ( !isBoolean( v ) ) {
+ b.fail( 'should return a boolean' );
+ }
+ b.pass( 'benchmark finished' );
+ b.end();
+});

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

@@ -0,0 +1,44 @@
+
+{{alias}}( iterator )
+ Returns an iterator which cumulatively tests whether every iterated value is
+ truthy.
+
+ If an environment supports Symbol.iterator and a provided iterator is
+ iterable, the returned iterator is iterable.
+
+ Parameters
+ ----------
+ iterator: Object
+ Input iterator.
+
+ Returns
+ -------
+ iterator: Object
+ Iterator.
+
+ iterator.next(): Function
+ Returns an iterator protocol-compliant object containing the next
+ iterated value (if one exists) and a boolean flag indicating whether the
+ iterator is finished.
+
+ iterator.return( [value] ): Function
+ Finishes an iterator and returns a provided value.
+
+ Examples
+ --------
+ > var arr = {{alias:@stdlib/array/to-iterator}}( [ 1, 1, 1, 0, 1 ] );
+ > var it = {{alias}}( arr );
+ > var v = it.next().value
+ true
+ > v = it.next().value
+ true
+ > v = it.next().value
+ true
+ > v = it.next().value
+ false
+ > v = it.next().value
+ false
+
+ See Also
+ --------
+

lib/node_modules/@stdlib/iter/cuevery/docs/types/index.d.ts

@@ -0,0 +1,64 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+
+// Define a union type representing both iterable and non-iterable iterators:
+type Iterator = Iter | IterableIterator;
+
+/**
+* Returns an iterator which cumulatively tests whether every iterated value is truthy.
+*
+* @param iterator - input iterator
+* @returns iterator
+*
+* @example
+* var array2iterator = require( '@stdlib/array/to-iterator' );
+*
+* var arr = array2iterator( [ true, true, true, false, true ] );
+*
+* var it = iterCuEvery( arr );
+*
+* var v = it.next().value;
+* returns true
+*
+* v = it.next().value;
+* returns true
+*
+* v = it.next().value;
+* returns true
+*
+* v = it.next().value;
+* returns false
+*
+* v = it.next().value;
+* returns false
+*
+* var bool = it.next().done;
+* returns true
+*/
+declare function iterCuEvery( iterator: Iterator ): Iterator;
+
+
+// EXPORTS //
+
+export = iterCuEvery;