/* * @license Apache-2.0 * * Copyright (c) 2025 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. */ // TypeScript Version: 4.1 /// import { ArrayLike } from '@stdlib/types/array'; import { typedndarray } from '@stdlib/types/ndarray'; /** * Returns a boolean indicating whether an element passes a test. * * @returns boolean indicating whether an ndarray element passes a test */ type Nullary = ( this: U ) => boolean; /** * Returns a boolean indicating whether an element passes a test. * * @param value - current array element * @returns boolean indicating whether an ndarray element passes a test */ type Unary = ( this: U, value: T ) => boolean; /** * Returns a boolean indicating whether an element passes a test. * * @param value - current array element * @param indices - current array element indices * @returns boolean indicating whether an ndarray element passes a test */ type Binary = ( this: U, value: T, indices: Array ) => boolean; /** * Returns a boolean indicating whether an element passes a test. * * @param value - current array element * @param indices - current array element indices * @param arr - input array * @returns boolean indicating whether an ndarray element passes a test */ type Ternary = ( this: U, value: T, indices: Array, arr: typedndarray ) => boolean; /** * Returns a boolean indicating whether an element passes a test. * * @param value - current array element * @param indices - current array element indices * @param arr - input array * @returns boolean indicating whether an ndarray element passes a test */ type Predicate = Nullary | Unary | Binary | Ternary; /** * Tests whether all elements in an ndarray pass a test implemented by a predicate function. * * @param arrays - array-like object containing an input ndarray * @param predicate - predicate function * @param thisArg - predicate function execution context * @returns boolean indicating whether all elements pass a test * * @example * var Float64Array = require( '@stdlib/array/float64' ); * var ndarray = require( '@stdlib/ndarray/base/ctor' ); * * function predicate( value ) { * return value > 0.0; * } * * // Create a data buffer: * var xbuf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0 ] ); * * // Define the shape of the array: * var shape = [ 3, 1, 2 ]; * * // Define the array strides: * var sx = [ 4, 4, 1 ]; * * // Define the index offset: * var ox = 1; * * // Create the input ndarray: * var x = ndarray( 'float64', xbuf, shape, sx, ox, 'row-major' ); * * // Test elements: * var out = everyBy( [ x ], predicate ); * // returns true */ declare function everyBy( arrays: ArrayLike>, predicate: Predicate, thisArg?: ThisParameterType> ): boolean; // EXPORTS // export = everyBy;