time-to-botec/squiggle/node_modules/@stdlib/utils/every-by-right/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

5.0 KiB

everyByRight

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

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>