everyByRight

Test whether all elements in a collection pass a test implemented by a predicate function, iterating from right to left.

Installation

npm install @stdlib/utils-every-by-right

Usage

var everyByRight = require( '@stdlib/utils-every-by-right' );

everyByRight( collection, predicate[, thisArg ] )

Tests whether all elements in a collection pass a test implemented by a predicate function, iterating from right to left.

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

var arr = [ 1, 2, 3, 4 ];

var bool = everyByRight( arr, isPositive );
// returns true

If a predicate function returns a non-truthy value, the function immediately returns false.

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

var arr = [ 1, -2, 3, 4 ];

var bool = everyByRight( arr, isPositive );
// returns false

The invoked function is provided three arguments:

• value: collection element
• index: collection index
• collection: input collection

To set the function execution context, provide a thisArg.

function sum( value ) {
    if ( value < 0 ) {
        return false;
    }
    this.sum += value;
    this.count += 1;
    return true;
}

var arr = [ 1, 2, 3, 4 ];

var context = {
    'sum': 0,
    'count': 0
};

var bool = everyByRight( arr, sum, context );
// returns true

var mean = context.sum / context.count;
// returns 2.5

Notes

• A collection may be either an Array, Typed Array, or an array-like Object (excluding strings and functions).

• If provided an empty collection, the function returns true.

  function untrue() {
      return false;
  }
  var bool = everyByRight( [], untrue );
  // returns true

• The function differs from Array.prototype.every in the following ways:

  • The function does not skip undefined elements.

    function log( value, index ) {
        console.log( '%s: %s', index, value );
        return true;
    }
    
    var arr = [ 1, , , 4 ];
    
    var bool = everyByRight( arr, log );
    /* =>
        3: 4
        2: undefined
        1: undefined
        0: 1
    */

  • The function provides limited support for dynamic collections (i.e., collections whose length changes during execution). Note, however, that index incrementation is not guaranteed to be monotonically decreasing.

Examples

var randu = require( '@stdlib/random-base-randu' );
var everyByRight = require( '@stdlib/utils-every-by-right' );

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

var bool;
var arr;
var i;

arr = new Array( 100 );
for ( i = 0; i < arr.length; i++ ) {
    arr[ i ] = randu();
}

bool = everyByRight( arr, isPositive );
// returns <boolean>

See Also

• @stdlib/utils-any-by: test whether at least one element in a collection passes a test implemented by a predicate function.
• @stdlib/utils-every: test whether all elements in a collection are truthy.
• @stdlib/utils-every-by: test whether all elements in a collection pass a test implemented by a predicate function.
• @stdlib/utils-for-each-right: invoke a function for each element in a collection, iterating from right to left.
• @stdlib/utils-none-by-right: test whether all elements in a collection fail a test implemented by a predicate function, iterating from right to left.
• @stdlib/utils-some-by-right: test whether a collection contains at least n elements which pass a test implemented by a predicate function, iterating from right to left.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.