Skip to content

Commit f9a3672

Browse files
headlessNodekgryte
headlessNode
and
kgryte
authored
feat: add blas/ext/base/gindex-of-not-equal
PR-URL: #13342 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#361
1 parent 1a2e90a commit f9a3672

15 files changed

Lines changed: 1677 additions & 0 deletions

File tree

‎lib/node_modules/@stdlib/blas/ext/base/gindex-of-not-equal/README.md‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2026 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# gindexOfNotEqual
22+
23+
> Return the first index of an element in a strided array which is not equal to a specified search element.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var gindexOfNotEqual = require( '@stdlib/blas/ext/base/gindex-of-not-equal' );
41+
```
42+
43+
#### gindexOfNotEqual( N, searchElement, x, strideX )
44+
45+
Returns the first index of an element in a strided array which is not equal to a specified search element.
46+
47+
```javascript
48+
var x = [ 1.0, 1.0, 0.0, 1.0 ];
49+
50+
var idx = gindexOfNotEqual( x.length, 1.0, x, 1 );
51+
// returns 2
52+
```
53+
54+
The function has the following parameters:
55+
56+
- **N**: number of indexed elements.
57+
- **searchElement**: search element.
58+
- **x**: input array.
59+
- **strideX**: stride length.
60+
61+
If all elements in the array are equal to the search element, the function returns `-1`.
62+
63+
```javascript
64+
var x = [ 1.0, 1.0, 1.0, 1.0 ];
65+
66+
var idx = gindexOfNotEqual( x.length, 1.0, x, 1 );
67+
// returns -1
68+
```
69+
70+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to search every other element:
71+
72+
```javascript
73+
var x = [ 1.0, 9.0, 0.0, 9.0, 1.0, 9.0 ];
74+
75+
var idx = gindexOfNotEqual( 3, 1.0, x, 2 );
76+
// returns 1
77+
```
78+
79+
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
80+
81+
```javascript
82+
var Float64Array = require( '@stdlib/array/float64' );
83+
84+
// Initial array...
85+
var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
86+
87+
// Create an offset view...
88+
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
89+
90+
// Find index...
91+
var idx = gindexOfNotEqual( 3, 2.0, x1, 2 );
92+
// returns 1
93+
```
94+
95+
#### gindexOfNotEqual.ndarray( N, searchElement, x, strideX, offsetX )
96+
97+
Returns the first index of an element in a strided array which is not equal to a specified search element using alternative indexing semantics.
98+
99+
```javascript
100+
var x = [ 1.0, 1.0, 0.0, 1.0 ];
101+
102+
var idx = gindexOfNotEqual.ndarray( x.length, 1.0, x, 1, 0 );
103+
// returns 2
104+
```
105+
106+
The function has the following additional parameters:
107+
108+
- **offsetX**: starting index.
109+
110+
While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the strided array:
111+
112+
```javascript
113+
var x = [ 1.0, 1.0, 0.0, 1.0 ];
114+
115+
var idx = gindexOfNotEqual.ndarray( 3, 1.0, x, 1, 1 );
116+
// returns 1
117+
```
118+
119+
</section>
120+
121+
<!-- /.usage -->
122+
123+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
124+
125+
<section class="notes">
126+
127+
## Notes
128+
129+
- 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.
130+
- Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
131+
132+
</section>
133+
134+
<!-- /.notes -->
135+
136+
<!-- Package usage examples. -->
137+
138+
<section class="examples">
139+
140+
## Examples
141+
142+
<!-- eslint no-undef: "error" -->
143+
144+
```javascript
145+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
146+
var gindexOfNotEqual = require( '@stdlib/blas/ext/base/gindex-of-not-equal' );
147+
148+
var x = discreteUniform( 10, 0, 3, {
149+
'dtype': 'generic'
150+
});
151+
console.log( x );
152+
153+
var idx = gindexOfNotEqual( x.length, 0.0, x, 1 );
154+
console.log( idx );
155+
```
156+
157+
</section>
158+
159+
<!-- /.examples -->
160+
161+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
162+
163+
<section class="references">
164+
165+
</section>
166+
167+
<!-- /.references -->
168+
169+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
170+
171+
<section class="related">
172+
173+
</section>
174+
175+
<!-- /.related -->
176+
177+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
178+
179+
<section class="links">
180+
181+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
182+
183+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
184+
185+
</section>
186+
187+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/gindex-of-not-equal/benchmark/benchmark.js‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var pow = require( '@stdlib/math/base/special/pow' );
25+
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
26+
var zeros = require( '@stdlib/array/zeros' );
27+
var format = require( '@stdlib/string/format' );
28+
var pkg = require( './../package.json' ).name;
29+
var gindexOfNotEqual = require( './../lib' );
30+
31+
32+
// FUNCTIONS //
33+
34+
/**
35+
* Creates a benchmark function.
36+
*
37+
* @private
38+
* @param {PositiveInteger} len - array length
39+
* @returns {Function} benchmark function
40+
*/
41+
function createBenchmark( len ) {
42+
var x = zeros( len, 'float64' );
43+
return benchmark;
44+
45+
/**
46+
* Benchmark function.
47+
*
48+
* @private
49+
* @param {Benchmark} b - benchmark instance
50+
*/
51+
function benchmark( b ) {
52+
var out;
53+
var i;
54+
55+
b.tic();
56+
for ( i = 0; i < b.iterations; i++ ) {
57+
out = gindexOfNotEqual( x.length, 0.0, x, 1 );
58+
if ( out !== out ) {
59+
b.fail( 'should return an integer' );
60+
}
61+
}
62+
b.toc();
63+
if ( !isInteger( out ) ) {
64+
b.fail( 'should return an integer' );
65+
}
66+
b.pass( 'benchmark finished' );
67+
b.end();
68+
}
69+
}
70+
71+
72+
// MAIN //
73+
74+
/**
75+
* Main execution sequence.
76+
*
77+
* @private
78+
*/
79+
function main() {
80+
var len;
81+
var min;
82+
var max;
83+
var f;
84+
var i;
85+
86+
min = 1; // 10^min
87+
max = 6; // 10^max
88+
89+
for ( i = min; i <= max; i++ ) {
90+
len = pow( 10, i );
91+
92+
f = createBenchmark( len );
93+
bench( format( '%s:len=%d', pkg, len ), f );
94+
}
95+
}
96+
97+
main();

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

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2026 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var pow = require( '@stdlib/math/base/special/pow' );
25+
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
26+
var zeros = require( '@stdlib/array/zeros' );
27+
var format = require( '@stdlib/string/format' );
28+
var pkg = require( './../package.json' ).name;
29+
var gindexOfNotEqual = require( './../lib/ndarray.js' );
30+
31+
32+
// FUNCTIONS //
33+
34+
/**
35+
* Creates a benchmark function.
36+
*
37+
* @private
38+
* @param {PositiveInteger} len - array length
39+
* @returns {Function} benchmark function
40+
*/
41+
function createBenchmark( len ) {
42+
var x = zeros( len, 'float64' );
43+
return benchmark;
44+
45+
/**
46+
* Benchmark function.
47+
*
48+
* @private
49+
* @param {Benchmark} b - benchmark instance
50+
*/
51+
function benchmark( b ) {
52+
var out;
53+
var i;
54+
55+
b.tic();
56+
for ( i = 0; i < b.iterations; i++ ) {
57+
out = gindexOfNotEqual( x.length, 0.0, x, 1, 0 );
58+
if ( out !== out ) {
59+
b.fail( 'should return an integer' );
60+
}
61+
}
62+
b.toc();
63+
if ( !isInteger( out ) ) {
64+
b.fail( 'should return an integer' );
65+
}
66+
b.pass( 'benchmark finished' );
67+
b.end();
68+
}
69+
}
70+
71+
72+
// MAIN //
73+
74+
/**
75+
* Main execution sequence.
76+
*
77+
* @private
78+
*/
79+
function main() {
80+
var len;
81+
var min;
82+
var max;
83+
var f;
84+
var i;
85+
86+
min = 1; // 10^min
87+
max = 6; // 10^max
88+
89+
for ( i = min; i <= max; i++ ) {
90+
len = pow( 10, i );
91+
92+
f = createBenchmark( len );
93+
bench( format( '%s:ndarray:len=%d', pkg, len ), f );
94+
}
95+
}
96+
97+
main();

0 commit comments

Comments
 (0)