Skip to content

Commit

Permalink
chore: clean-up implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
Planeshifter committed Sep 25, 2024
1 parent 585e867 commit a958397
Show file tree
Hide file tree
Showing 15 changed files with 945 additions and 886 deletions.
152 changes: 152 additions & 0 deletions lib/node_modules/@stdlib/array/base/cuany-by-right/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
<!--
@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.
-->

# cuanyByRight

> Cumulatively test whether at least one element in a provided array passes a test implemented by a predicate function, while iterating from right-to-left.
<section class="usage">

## Usage

```javascript
var cuanyByRight = require( '@stdlib/array/base/cuany-by-right' );
```

#### cuanyByRight( x, predicate\[, thisArg] )

Cumulatively tests whether at least one element in a provided array passes a test implemented by a `predicate` function, while iterating from right-to-left.

```javascript
function isPositive( value ) {
return ( value > 0 );
}

var x = [ 0, 0, 0, 1, 0 ];

var y = cuanyByRight( x, isPositive );
// returns [ false, true, true, true, true ]
```

The `predicate` function is provided three arguments:

- **value**: current array element.
- **index**: current array element index.
- **arr**: input array.

To set the `predicate` function execution context, provide a `thisArg`.

```javascript
function isPositive( value ) {
this.count += 1;
return ( value > 0 );
}

var x = [ 0, 1, 0, 0, 0 ];

var context = {
'count': 0
};

var out = cuanyByRight( x, isPositive, context );
// returns [ false, false, false, true, true ]

var cnt = context.count;
// returns 4
```

#### cuanyByRight.assign( x, out, stride, offset, predicate\[, thisArg] )

Cumulatively tests whether at least one element in a provided array passes a test implemented by a `predicate` function, while iterating from right-to-left, and assigns results to a provided output array.

```javascript
function isPositive( value ) {
return ( value > 0 );
}

var x = [ 0, 1, 0, 0, 0 ];
var y = [ false, null, false, null, false, null, false, null, false, null ];

var out = cuanyByRight.assign( x, y, 2, 0, isPositive );
// returns [ false, null, false, null, false, null, true, null, true, null ]

var bool = ( out === y );
// returns true
```

The function supports the following parameters:

- **x**: input array.
- **out**: output array.
- **stride**: output array stride.
- **offset**: output array offset.
- **predicate**: test function.

</section>

<!-- /.usage -->

<section class="notes">

</section>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
function isPositive( value ) {
return ( value > 0 );
}

var bernoulli = require( '@stdlib/random/array/bernoulli' );
var cuanyByRight = require( '@stdlib/array/base/cuany-by-right' );

// Create an array of random values:
var x = bernoulli( 10, 0.1 );
console.log( x );

var out = cuanyByRight( x, isPositive );
console.log( out );
```

</section>

<!-- /.examples -->

<!-- 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">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
var bench = require( '@stdlib/bench' );
var pow = require( '@stdlib/math/base/special/pow' );
var isArray = require( '@stdlib/assert/is-array' );
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
var filled = require( '@stdlib/array/base/filled' );
var pkg = require( './../package.json' ).name;
var cuanyByRight = require( './../lib' );
Expand All @@ -38,48 +39,38 @@ var cuanyByRight = require( './../lib' );
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filled( 1.5, len );
return benchmark;
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;
/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var y;
var v;
var i;

y = filled( false, len );
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();
}
b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = cuanyByRight.assign( x, y, 1, 0, isPositiveInteger );
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 //

Expand All @@ -89,20 +80,20 @@ function isPositive( value ) {
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max
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 );
}
for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( pkg+':assign:len='+len, f );
}
}

main();
Original file line number Diff line number Diff line change
Expand Up @@ -22,41 +22,31 @@

var bench = require( '@stdlib/bench' );
var isArray = require( '@stdlib/assert/is-array' );
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
var pkg = require( './../package.json' ).name;
var cuanyByRight = require( './../lib' );


// 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();
var x;
var i;
var v;

x = [ 1, 1, 0, 0, 0 ];

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = cuanyByRight( x, isPositiveInteger );
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 );
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
var bench = require( '@stdlib/bench' );
var pow = require( '@stdlib/math/base/special/pow' );
var isArray = require( '@stdlib/assert/is-array' );
var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
var filled = require( '@stdlib/array/base/filled' );
var pkg = require( './../package.json' ).name;
// var cuanyByRight = require( './../lib' );
import cuanyByRight from '@stdlib/array/base/cuany-by-right/lib/main';
var cuanyByRight = require( './../lib' );


// FUNCTIONS //
Expand All @@ -39,7 +39,7 @@ import cuanyByRight from '@stdlib/array/base/cuany-by-right/lib/main';
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = filled( 1.5, len );
var x = filled( 0, len );
return benchmark;

/**
Expand All @@ -54,7 +54,7 @@ function createBenchmark( len ) {

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = cuanyByRight( x, isPositive );
v = cuanyByRight( x, isPositiveInteger );
if ( typeof v !== 'object' ) {
b.fail( 'should return an array' );
}
Expand All @@ -68,16 +68,6 @@ function createBenchmark( len ) {
}
}

/**
* 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 //

Expand Down
Loading

0 comments on commit a958397

Please sign in to comment.