Skip to content
Draft
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# sindexOfNotEqual

> Return the first index of an element in a one-dimensional ndarray which is not equal to a specified search element.

<section class="intro">

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var sindexOfNotEqual = require( '@stdlib/blas/ext/base/ndarray/sindex-of-not-equal' );
```

#### sindexOfNotEqual( arrays )

Returns the first index of an element in a one-dimensional ndarray which is not equal to a specified search element.

```javascript
var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );

var x = new Float32Vector( [ 1.0, 1.0, 3.0 ] );

var searchElement = scalar2ndarray( 1.0, {
'dtype': 'float32'
});

var idx = sindexOfNotEqual( [ x, searchElement ] );
// returns 2
```

The function has the following parameters:

- **arrays**: array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the search element.

If the function is unable to find an element which is not equal to a specified search element, the function returns `-1`.

```javascript
var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );

var x = new Float32Vector( [ 1.0, 1.0, 1.0 ] );

var searchElement = scalar2ndarray( 1.0, {
'dtype': 'float32'
});

var idx = sindexOfNotEqual( [ x, searchElement ] );
// returns -1
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

- 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>

<!-- /.notes -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var discreteUniform = require( '@stdlib/random/discrete-uniform' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
var sindexOfNotEqual = require( '@stdlib/blas/ext/base/ndarray/sindex-of-not-equal' );

var opts = {
'dtype': 'float32'
};

var x = discreteUniform( [ 10 ], -100, 100, opts );
console.log( ndarray2array( x ) );

var searchElement = scalar2ndarray( 80.0, opts );
console.log( 'Search Element:', ndarraylike2scalar( searchElement ) );

var idx = sindexOfNotEqual( [ x, searchElement ] );
console.log( idx );
```

</section>

<!-- /.examples -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">

</section>

<!-- /.related -->

<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="links">

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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.
*/

'use strict';

// MODULES //

var bench = require( '@stdlib/bench' );
var zeros = require( '@stdlib/ndarray/zeros' );
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var pow = require( '@stdlib/math/base/special/pow' );
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var sindexOfNotEqual = require( './../lib' );


// VARIABLES //

var options = {
'dtype': 'float32'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var searchElement;
var x;

x = zeros( [ len ], options );
searchElement = scalar2ndarray( 0.0, options );

return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var out;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
out = sindexOfNotEqual( [ x, searchElement ] );
if ( out !== out ) {
b.fail( 'should return an integer' );
}
}
b.toc();
if ( !isInteger( out ) ) {
b.fail( 'should return an integer' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

main();
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{{alias}}( arrays )
Returns the first index of an element in a one-dimensional ndarray which is
not equal to a specified search 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.

If unable to find an element which is not equal to a specified search
element, the function returns `-1`.

Parameters
----------
arrays: ArrayLikeObject<ndarray>
Array-like object containing the following ndarrays:

- a one-dimensional input ndarray.
- a zero-dimensional ndarray containing the search element.

Returns
-------
out: integer
Index.

Examples
--------
> var x = new ({{alias:@stdlib/ndarray/vector/float32}})( [ 1.0, 1.0, 3.0 ] );
> var v = {{alias:@stdlib/ndarray/from-scalar}}( 1.0, { 'dtype': 'float32' } );
> {{alias}}( [ x, v ] )
2

See Also
--------
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2026 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 { typedndarray } from '@stdlib/types/ndarray';

/**
* Returns the first index of an element in a one-dimensional ndarray which is not equal to a specified search element.
*
* ## Notes
*
* - The function expects the following ndarrays:
*
* - a one-dimensional input ndarray.
* - a zero-dimensional ndarray containing the search element.
*
* @param arrays - array-like object containing ndarrays
* @returns index
*
* @example
* var Float32Vector = require( '@stdlib/ndarray/vector/float32' );
* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
*
* var x = new Float32Vector( [ 1.0, 1.0, 3.0 ] );
*
* var searchElement = scalar2ndarray( 1.0, {
* 'dtype': 'float32'
* });
*
* var v = sindexOfNotEqual( [ x, searchElement ] );
* // returns 2
*/
declare function sindexOfNotEqual( arrays: [ typedndarray<number>, typedndarray<number> ] ): number;


// EXPORTS //

export = sindexOfNotEqual;
Loading
Loading