Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions lib/node_modules/@stdlib/blas/ext/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ import fillBetween = require( '@stdlib/blas/ext/fill-between' );
import findIndex = require( '@stdlib/blas/ext/find-index' );
import findIndexBetween = require( '@stdlib/blas/ext/find-index-between' );
import findLastIndex = require( '@stdlib/blas/ext/find-last-index' );
import findLastIndexBetween = require( '@stdlib/blas/ext/find-last-index-between' );
import firstIndexLessThan = require( '@stdlib/blas/ext/first-index-less-than' );
import indexOf = require( '@stdlib/blas/ext/index-of' );
import indexOfFalsy = require( '@stdlib/blas/ext/index-of-falsy' );
import indexOfNotEqual = require( '@stdlib/blas/ext/index-of-not-equal' );
import indexOfTruthy = require( '@stdlib/blas/ext/index-of-truthy' );
import join = require( '@stdlib/blas/ext/join' );
import lastIndexEqual = require( '@stdlib/blas/ext/last-index-equal' );
import lastIndexOf = require( '@stdlib/blas/ext/last-index-of' );
import lastIndexOfFalsy = require( '@stdlib/blas/ext/last-index-of-falsy' );
import lastIndexOfTruthy = require( '@stdlib/blas/ext/last-index-of-truthy' );
Expand Down Expand Up @@ -439,6 +441,52 @@ interface Namespace {
*/
findLastIndex: typeof findLastIndex;

/**
* Returns the index of the last element along an ndarray dimension which passes a test implemented by a predicate function within a specified range.
*
* ## Notes
*
* - If no element along an ndarray dimension passes a test implemented by the predicate function, the corresponding element in the returned ndarray is `-1`.
*
* @param x - input ndarray
* @param fromIndex - index from which to begin searching
* @param toIndex - index at which to stop searching (exclusive)
* @param options - function options
* @param clbk - predicate function
* @param thisArg - predicate function execution context
* @returns output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
*
* function clbk( value ) {
* return value % 2.0 === 0.0;
* }
*
* var x = array( [ 2.0, 1.0, -3.0, 4.0 ] );
*
* var y = ns.findLastIndexBetween( x, 3, 1, clbk );
* // returns <ndarray>[ 3 ]
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* function clbk( value ) {
* return value % 2.0 === 0.0;
* }
*
* var x = array( [ 2.0, 1.0, -3.0, 4.0 ] );
* var y = zeros( [] );
*
* var out = ns.findLastIndexBetween.assign( x, 3, 1, y, clbk );
* // returns <ndarray>[ 3 ]
*
* var bool = ( out === y );
* // returns true
*/
findLastIndexBetween: typeof findLastIndexBetween;

/**
* Returns the index of the first element in an ndarray which is less than a corresponding element in another ndarray along an ndarray dimension.
*
Expand Down Expand Up @@ -668,6 +716,53 @@ interface Namespace {
*/
join: typeof join;

/**
* Returns the index of the last element in an ndarray which is equal to a corresponding element in another ndarray along an ndarray dimension.
*
* ## Notes
*
* - When comparing elements, the function checks for equality using the strict equality operator `===`. As a consequence, `NaN` values are considered distinct, and `-0` and `+0` are considered the same.
* - If unable to find an element which is equal to a corresponding element in the second input ndarray along an ndarray dimension, the corresponding element in the returned ndarray is `-1`.
*
* @param x - first input ndarray
* @param y - second input ndarray
* @param fromIndex - index from which to begin searching
* @param options - function options
* @returns output ndarray
*
* @example
* var array = require( '@stdlib/ndarray/array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = array( [ 0.0, 2.0, 0.0 ] );
* var y = scalar2ndarray( 0.0, {
* 'dtype': 'float64'
* } );
*
* var out = ns.lastIndexEqual( x, y );
* // returns <ndarray>[ 2 ]
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
* var array = require( '@stdlib/ndarray/array' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = array( [ 0.0, 2.0, 0.0, 0.0, 5.0, 6.0 ] );
* var y = scalar2ndarray( 0.0, {
* 'dtype': 'float64'
* } );
* var z = zeros( [], {
* 'dtype': 'int32'
* } );
*
* var out = ns.lastIndexEqual.assign( x, y, 2, z );
* // returns <ndarray>[ 2 ]
*
* var bool = ( out === z );
* // returns true
*/
lastIndexEqual: typeof lastIndexEqual;

/**
* Returns the last index of a specified search element along an ndarray dimension.
*
Expand Down
Loading