Typed Array Function

Return a function which tests if every element in a typed array passes a test condition.

Usage

var typedarrayfcn = require( '@stdlib/assert/tools/typed-array-function' );

typedarrayfcn( predicate )

Returns a function which tests if every element in a typed array passes a test condition. Given an input typed array, the function returns true if all elements pass the test and false otherwise.

var isOdd = require( '@stdlib/assert/is-odd' );
var Int32Array = require( '@stdlib/array/int32' );

var arr1 = new Int32Array( [ 1, 3, 5, 7 ] );
var arr2 = new Int32Array( [ 3, 5, 8 ] );

var f = typedarrayfcn( isOdd );

var bool = f( isOdd, arr1 );
// returns true

bool = f( isOdd, arr2 );
// returns false

Notes

  • The returned function will return false if not provided a typed array.
  • The returned function will return false if provided an empty typed array.
  • A predicate function should accept a single argument: a typed array element. If the element satisfies a test condition, the predicate function should return true; otherwise, the predicate function should return false.

Examples

var isEven = require( '@stdlib/assert/is-even' );
var Int32Array = require( '@stdlib/array/int32' );
var typedarrayfcn = require( '@stdlib/assert/tools/typed-array-function' );

var arr1;
var arr2;
var bool;
var f;
var i;

arr1 = new Int32Array( 25 );
for ( i = 0; i < arr1.length; i++ ) {
    arr1[ i ] = i;
}

arr2 = new Int32Array( 25 );
for ( i = 0; i < arr2.length; i++ ) {
    arr2[ i ] = 2 * i;
}

f = typedarrayfcn( isEven );

bool = f( arr1 );
// returns false

bool = f( arr2 );
// returns true