feat: add array/base/cuany-by-right

lib/node_modules/@stdlib/array/base/cuany-by-right/benchmark/benchmark.assign.length.js

@@ -0,0 +1,108 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var isArray = require( '@stdlib/assert/is-array' );
+var filled = require( '@stdlib/array/base/filled' );
+var pkg = require( './../package.json' ).name;
+var cuanyByRight = require( './../lib' ).cuanyByRight;
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+    var x = filled( 1.5, len );
+    return benchmark;
+
+    /**
+    * Benchmark function.
+    *
+    * @private
+    * @param {Benchmark} b - benchmark instance
+    */
+    function benchmark( b ) {
+        var y;
+        var v;
+        var i;
+
+        y = filled( false, len );
+
+        b.tic();
+        for ( i = 0; i < b.iterations; i++ ) {
+            v = cuanyByRight.assign( x, y, 1, 0, isPositive );
+            if ( typeof v !== 'object' ) {
+                b.fail( 'should return an array' );
+            }
+        }
+        b.toc();
+        if ( !isArray( v ) ) {
+            b.fail( 'should return an array' );
+        }
+        b.pass( 'benchmark finished' );
+        b.end();
+    }
+}
+
+/**
+* Predicate function to test if a value is positive.
+*
+* @private
+* @param {number} value - input value
+* @returns {boolean} boolean indicating whether the value is positive
+*/
+function isPositive( value ) {
+    return ( value > 0 );
+}
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+    var len;
+    var min;
+    var max;
+    var f;
+    var i;
+
+    min = 1; // 10^min
+    max = 6; // 10^max
+
+    for ( i = min; i <= max; i++ ) {
+        len = pow( 10, i );
+        f = createBenchmark( len );
+        bench( pkg+':assign:len='+len, f );
+    }
+}
+
+main();

lib/node_modules/@stdlib/array/base/cuany-by-right/benchmark/benckmark.js

@@ -0,0 +1,63 @@
+/**
+* @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 isArray = require( '@stdlib/assert/is-array' );
+var pkg = require( './../package.json' ).name;
+var cuanyByRight = require( './../lib' ).cuanyByRight;
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+    var x;
+    var i;
+    var v;
+
+    x = [ 0, 1, 0, 0, 0 ];
+
+    b.tic();
+    for ( i = 0; i < b.iterations; i++ ) {
+        v = cuanyByRight( x, isPositive );
+        if ( typeof v !== 'object' ) {
+            b.fail( 'should return an array' );
+        }
+    }
+    b.toc();
+    if ( !isArray( v ) ) {
+        b.fail( 'should return an array' );
+    }
+    b.pass( 'benchmark finished' );
+    b.end();
+});
+
+/**
+* Predicate function to test if a value is positive.
+*
+* @private
+* @param {number} value - input value
+* @returns {boolean} boolean indicating whether the value is positive
+*/
+function isPositive( value ) {
+    return ( value > 0 );
+}
+

lib/node_modules/@stdlib/array/base/cuany-by-right/benchmark/benckmark.length.js

@@ -0,0 +1,105 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var isArray = require( '@stdlib/assert/is-array' );
+var filled = require( '@stdlib/array/base/filled' );
+var pkg = require( './../package.json' ).name;
+var cuanyByRight = require( './../lib' ).cuanyByRight;
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = filled( 1.5, len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = cuanyByRight( x, isPositive );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an array' );
+			}
+		}
+		b.toc();
+		if ( !isArray( v ) ) {
+			b.fail( 'should return an array' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+/**
+* Predicate function to test if a value is positive.
+*
+* @private
+* @param {number} value - input value
+* @returns {boolean} boolean indicating whether the value is positive
+*/
+function isPositive( value ) {
+	return ( value > 0 );
+}
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/base/cuany-by-right/docs/repl.txt

@@ -0,0 +1,52 @@
+cuanyByRight( x )
+    Cumulatively tests whether at least one element in a provided array is
+    truthy, starting from the rightmost element.
+
+    Parameters
+    ----------
+    x: ArrayLikeObject
+        Input array.
+
+    Returns
+    -------
+    out: Array
+        Output array.
+
+    Examples
+    --------
+    > var x = [ false, false, true, false, false ];
+    > var y = cuanyByRight( x )
+    [ false, false, true, true, true ]
+
+
+cuanyByRight.assign( x, y, stride, offset )
+    Cumulatively tests whether at least one element in an array is truthy, starting from the rightmost element, and assigns results to provided output array.
+
+    Parameters
+    ----------
+    x: ArrayLikeObject
+        Input array.
+
+    y: ArrayLikeObject
+        Output array.
+
+    stride: integer
+        Output array stride.
+
+    offset: integer
+        Output array offset.
+
+    Returns
+    -------
+    y: ArrayLikeObject
+        Output array.
+
+    Examples
+    --------
+    > var x = [ false, false, true, false, false ];
+    > var y = [ false, null, false, null, false, null, false, null, false ];
+    > var result = cuanyByRight.assign( x, y, 2, 0 )
+    [ false, null, true, null, true, null, true, null, true ]
+
+    See Also
+    --------