feat!: add fromIndex support to blas/ext/base/ndarray/dindex-of-not-equal

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/README.md

@@ -50,7 +50,11 @@ var searchElement = scalar2ndarray( 1.0, {
     'dtype': 'float64'
 });
 
-var idx = dindexOfNotEqual( [ x, searchElement ] );
+var fromIndex = scalar2ndarray( 0, {
+    'dtype': 'generic'
+});
+
+var idx = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 // returns 2
 ```
 
@@ -60,6 +64,7 @@ The function has the following parameters:
 
     -   a one-dimensional input ndarray.
     -   a zero-dimensional ndarray containing the search element.
+    -   a zero-dimensional ndarray containing the index from which to begin searching.
 
 If the function is unable to find an element which is not equal to a specified search element, the function returns `-1`.
 
@@ -73,7 +78,11 @@ var searchElement = scalar2ndarray( 1.0, {
     'dtype': 'float64'
 });
 
-var idx = dindexOfNotEqual( [ x, searchElement ] );
+var fromIndex = scalar2ndarray( 0, {
+    'dtype': 'generic'
+});
+
+var idx = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 // returns -1
 ```
 
@@ -85,6 +94,7 @@ var idx = dindexOfNotEqual( [ x, searchElement ] );
 
 ## Notes
 
+-   If a specified starting search index is negative, the function resolves the starting search index by counting backward from the last element (where `-1` refers to the last element).
 -   When searching for a search element, the function checks for inequality using the strict inequality operator `!==`. As a consequence, `NaN` values are considered distinct from all values (including other `NaN` values), and `-0` and `+0` are considered the same.
 
 </section>
@@ -114,7 +124,12 @@ console.log( ndarray2array( x ) );
 var searchElement = scalar2ndarray( 0, opts );
 console.log( 'Search Element:', ndarraylike2scalar( searchElement ) );
 
-var idx = dindexOfNotEqual( [ x, searchElement ] );
+var fromIndex = scalar2ndarray( 0, {
+    'dtype': 'generic'
+});
+console.log( 'From Index:', ndarraylike2scalar( fromIndex ) );
+
+var idx = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 console.log( idx );
 ```
 

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/benchmark/benchmark.js

@@ -48,11 +48,14 @@ var options = {
 */
 function createBenchmark( len ) {
 	var searchElement;
+	var fromIndex;
 	var x;
 
 	x = zeros( [ len ], options );
 	searchElement = scalar2ndarray( 0.0, options );
-
+	fromIndex = scalar2ndarray( 0, {
+		'dtype': 'generic'
+	});
 	return benchmark;
 
 	/**
@@ -67,7 +70,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			out = dindexOfNotEqual( [ x, searchElement ] );
+			out = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 			if ( out !== out ) {
 				b.fail( 'should return an integer' );
 			}

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/docs/repl.txt

@@ -3,6 +3,10 @@
     Returns the first index of an element in a one-dimensional double-precision
     floating-point ndarray which is not equal to a specified search element.
 
+    If a specified starting search index is negative, the function resolves the
+    starting search index by counting backward from the last element (where `-1`
+    refers to the last element).
+
     When searching for a search element, the function checks for inequality
     using the strict inequality operator `!==`. As a consequence, `NaN` values
     are considered distinct from all values (including other `NaN` values), and
@@ -18,6 +22,8 @@
 
         - a one-dimensional input ndarray.
         - a zero-dimensional ndarray containing the search element.
+        - a zero-dimensional ndarray containing the index from which to begin
+        searching.
 
     Returns
     -------
@@ -28,7 +34,8 @@
     --------
     > var x = new {{alias:@stdlib/ndarray/vector/float64}}( [ 1.0, 1.0, 3.0 ] );
     > var v = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': 'float64' } );
-    > {{alias}}( [ x, v ] )
+    > var i = {{alias:@stdlib/ndarray/from-scalar}}( 0, { 'dtype': 'generic' } );
+    > {{alias}}( [ x, v, i ] )
     2
 
     See Also

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/docs/types/index.d.ts

@@ -31,6 +31,7 @@ import { float64ndarray, typedndarray } from '@stdlib/types/ndarray';
 *
 *     -   a one-dimensional input ndarray.
 *     -   a zero-dimensional ndarray containing the search element.
+*     -   a zero-dimensional ndarray containing the index from which to begin searching.
 *
 * @param arrays - array-like object containing ndarrays
 * @returns index
@@ -45,10 +46,14 @@ import { float64ndarray, typedndarray } from '@stdlib/types/ndarray';
 *     'dtype': 'float64'
 * });
 *
-* var v = dindexOfNotEqual( [ x, searchElement ] );
+* var fromIndex = scalar2ndarray( 0, {
+*     'dtype': 'generic'
+* });
+*
+* var v = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 * // returns 2
 */
-declare function dindexOfNotEqual( arrays: [ float64ndarray, typedndarray<number> ] ): number;
+declare function dindexOfNotEqual( arrays: [ float64ndarray, typedndarray<number>, typedndarray<number> ] ): number;
 
 
 // EXPORTS //

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/docs/types/test.ts

@@ -33,8 +33,11 @@ import dindexOfNotEqual = require( './index' );
 	const searchElement = scalar2ndarray( 0.0, {
 		'dtype': 'float64'
 	});
+	const fromIndex = scalar2ndarray( 0, {
+		'dtype': 'generic'
+	});
 
-	dindexOfNotEqual( [ x, searchElement ] ); // $ExpectType number
+	dindexOfNotEqual( [ x, searchElement, fromIndex ] ); // $ExpectType number
 }
 
 // The compiler throws an error if the function is provided a first argument which is not an array of ndarrays...
@@ -58,7 +61,10 @@ import dindexOfNotEqual = require( './index' );
 	const searchElement = scalar2ndarray( 0.0, {
 		'dtype': 'float64'
 	});
+	const fromIndex = scalar2ndarray( 0, {
+		'dtype': 'generic'
+	});
 
 	dindexOfNotEqual(); // $ExpectError
-	dindexOfNotEqual( [ x, searchElement ], {} ); // $ExpectError
+	dindexOfNotEqual( [ x, searchElement, fromIndex ], {} ); // $ExpectError
 }

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/examples/index.js

@@ -34,5 +34,10 @@ console.log( ndarray2array( x ) );
 var searchElement = scalar2ndarray( 0, opts );
 console.log( 'Search Element:', ndarraylike2scalar( searchElement ) );
 
-var idx = dindexOfNotEqual( [ x, searchElement ] );
+var fromIndex = scalar2ndarray( 0, {
+	'dtype': 'generic'
+});
+console.log( 'From Index:', ndarraylike2scalar( fromIndex ) );
+
+var idx = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 console.log( idx );

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/lib/index.js

@@ -34,7 +34,11 @@
 *     'dtype': 'float64'
 * });
 *
-* var v = dindexOfNotEqual( [ x, searchElement ] );
+* var fromIndex = scalar2ndarray( 0, {
+*     'dtype': 'generic'
+* });
+*
+* var v = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 * // returns 2
 */
 

lib/node_modules/@stdlib/blas/ext/base/ndarray/dindex-of-not-equal/lib/main.js

@@ -25,6 +25,7 @@ var getStride = require( '@stdlib/ndarray/base/stride' );
 var getOffset = require( '@stdlib/ndarray/base/offset' );
 var getData = require( '@stdlib/ndarray/base/data-buffer' );
 var ndarraylike2scalar = require( '@stdlib/ndarray/base/ndarraylike2scalar' );
+var clipIndex = require( '@stdlib/ndarray/base/clip-index' );
 var strided = require( '@stdlib/blas/ext/base/dindex-of-not-equal' ).ndarray;
 
 
@@ -39,6 +40,7 @@ var strided = require( '@stdlib/blas/ext/base/dindex-of-not-equal' ).ndarray;
 *
 *     -   a one-dimensional input ndarray.
 *     -   a zero-dimensional ndarray containing the search element.
+*     -   a zero-dimensional ndarray containing the index from which to begin searching.
 *
 * @param {ArrayLikeObject<Object>} arrays - array-like object containing ndarrays
 * @returns {integer} index
@@ -53,12 +55,41 @@ var strided = require( '@stdlib/blas/ext/base/dindex-of-not-equal' ).ndarray;
 *     'dtype': 'float64'
 * });
 *
-* var v = dindexOfNotEqual( [ x, searchElement ] );
+* var fromIndex = scalar2ndarray( 0, {
+*     'dtype': 'generic'
+* });
+*
+* var v = dindexOfNotEqual( [ x, searchElement, fromIndex ] );
 * // returns 2
 */
 function dindexOfNotEqual( arrays ) {
-	var x = arrays[ 0 ];
-	return strided( numelDimension( x, 0 ), ndarraylike2scalar( arrays[ 1 ] ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len
+	var searchElement;
+	var fromIndex;
+	var stride;
+	var offset;
+	var idx;
+	var N;
+	var x;
+
+	x = arrays[ 0 ];
+	searchElement = ndarraylike2scalar( arrays[ 1 ] );
+	fromIndex = ndarraylike2scalar( arrays[ 2 ] );
+
+	N = numelDimension( x, 0 );
+	fromIndex = clipIndex( fromIndex, N );
+	if ( fromIndex >= N ) {
+		return -1;
+	}
+	N -= fromIndex;
+
+	stride = getStride( x, 0 );
+	offset = getOffset( x ) + ( stride*fromIndex );
+
+	idx = strided( N, searchElement, getData( x ), stride, offset );
+	if ( idx >= 0 ) {
+		idx += fromIndex;
+	}
+	return idx;
 }