UNPKG

@stdlib/array

Version:
150 lines (134 loc) 4.02 kB
/* * @license Apache-2.0 * * Copyright (c) 2021 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 /// <reference types="@stdlib/types"/> import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter'; import { ArrayLike } from '@stdlib/types/array'; // Define a union type representing both iterable and non-iterable iterators: type Iterator = Iter | IterableIterator; /** * Map function invoked for each iterated value. * * @returns iterator value */ type Nullary = () => any; /** * Map function invoked for each iterated value. * * @param value - iterated value * @returns iterator value */ type Unary = ( value: any ) => any; /** * Map function invoked for each iterated value. * * @param value - iterated value * @param index - iterated value index * @returns iterator value */ type Binary = ( value: any, index: number ) => any; /** * Map function invoked for each iterated value. * * @param value - iterated value * @param index - iterated value index * @param src - source array-like object * @returns iterator value */ type Ternary = ( value: any, index: number, src: ArrayLike<any> ) => any; /** * Map function invoked for each iterated value. * * @param value - iterated value * @param index - iterated value index * @param src - source array-like object * @returns iterator value */ type MapFunction = Nullary | Unary | Binary | Ternary; /** * Returns an iterator which iterates from right to left over each element in an array-like object view. * * @param src - input value * @param mapFcn - function to invoke for each iterated value * @param thisArg - execution context * @returns iterator * * @example * function fcn( v ) { * return v * 10.0; * } * * var iter = arrayview2iteratorRight( [ 1, 2, 3, 4 ], fcn ); * * var v = iter.next().value; * // returns 3 * * v = iter.next().value; * // returns 2 * * var bool = iter.next().done; * // returns true */ declare function arrayview2iteratorRight( src: ArrayLike<any>, mapFcn?: MapFunction, thisArg?: any ): Iterator; /** * Returns an iterator which iterates from right to left over each element in an array-like object view. * * @param src - input value * @param begin - starting **view** index (inclusive) (default: 0) * @param mapFcn - function to invoke for each iterated value * @param thisArg - execution context * @returns iterator * * @example * var iter = arrayview2iteratorRight( [ 1, 2, 3, 4 ], 1 ); * * var v = iter.next().value; * // returns 3 * * v = iter.next().value; * // returns 2 * * var bool = iter.next().done; * // returns false */ declare function arrayview2iteratorRight( src: ArrayLike<any>, begin: number, mapFcn?: MapFunction, thisArg?: any ): Iterator; /** * Returns an iterator which iterates from right to left over each element in an array-like object view. * * @param src - input value * @param begin - starting **view** index (inclusive) (default: 0) * @param end - ending **view** index (non-inclusive) (default: src.length) * @param mapFcn - function to invoke for each iterated value * @param thisArg - execution context * @returns iterator * * @example * var iter = arrayview2iteratorRight( [ 1, 2, 3, 4 ], 1, 3 ); * * var v = iter.next().value; * // returns 3 * * v = iter.next().value; * // returns 2 * * var bool = iter.next().done; * // returns true */ declare function arrayview2iteratorRight( src: ArrayLike<any>, begin: number, end: number, mapFcn?: MapFunction, thisArg?: any ): Iterator; // EXPORTS // export = arrayview2iteratorRight;