Skip to content

Commit 5a60a91

Browse files
headlessNodeheadlessNode
authored
feat: add blas/ext/base/gindex-of-falsy
PR-URL: #12940 Reviewed-by: Athan Reines <kgryte@gmail.com> Closes: stdlib-js/metr-issue-tracker#527
1 parent bfaddc8 commit 5a60a91

15 files changed

Lines changed: 1432 additions & 0 deletions

File tree

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

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
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+
# gindexOfFalsy
22+
23+
> Return the index of the first falsy element in a strided array.
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 gindexOfFalsy = require( '@stdlib/blas/ext/base/gindex-of-falsy' );
41+
```
42+
43+
#### gindexOfFalsy( N, x, strideX )
44+
45+
Returns the index of the first falsy element in a strided array.
46+
47+
```javascript
48+
var x = [ 1.0, 3.0, 0.0, 2.0, 4.0, 1.0, -1.0, 3.0 ];
49+
50+
var idx = gindexOfFalsy( x.length, x, 1 );
51+
// returns 2
52+
```
53+
54+
The function has the following parameters:
55+
56+
- **N**: number of indexed elements.
57+
- **x**: input array.
58+
- **strideX**: stride length.
59+
60+
If the function is unable to find a falsy element, the function returns `-1`.
61+
62+
```javascript
63+
var x = [ 1.0, 2.0, 3.0, 4.0 ];
64+
65+
var idx = gindexOfFalsy( x.length, x, 1 );
66+
// returns -1
67+
```
68+
69+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to search every other element:
70+
71+
```javascript
72+
var x = [ 1.0, 3.0, 0.0, 2.0, 4.0, 1.0, -1.0, 3.0 ];
73+
74+
var idx = gindexOfFalsy( 4, x, 2 );
75+
// returns 1
76+
```
77+
78+
Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
79+
80+
```javascript
81+
var Float64Array = require( '@stdlib/array/float64' );
82+
83+
// Initial array...
84+
var x0 = new Float64Array( [ 1.0, 3.0, 1.0, 0.0, 2.0, 1.0 ] );
85+
86+
// Create an offset view...
87+
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
88+
89+
// Find index...
90+
var idx = gindexOfFalsy( 3, x1, 2 );
91+
// returns 1
92+
```
93+
94+
#### gindexOfFalsy.ndarray( N, x, strideX, offsetX )
95+
96+
Returns the index of the first falsy element in a strided array using alternative indexing semantics.
97+
98+
```javascript
99+
var x = [ 1.0, 3.0, 0.0, 2.0, 4.0, 1.0, -1.0, 3.0 ];
100+
101+
var idx = gindexOfFalsy.ndarray( x.length, x, 1, 0 );
102+
// returns 2
103+
```
104+
105+
The function has the following additional parameters:
106+
107+
- **offsetX**: starting index.
108+
109+
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:
110+
111+
```javascript
112+
var x = [ 1.0, 3.0, 0.0, 2.0, 4.0, 1.0, 3.0, 0.0 ];
113+
114+
var idx = gindexOfFalsy.ndarray( 3, x, 1, x.length-3 );
115+
// returns 2
116+
```
117+
118+
</section>
119+
120+
<!-- /.usage -->
121+
122+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
123+
124+
<section class="notes">
125+
126+
## Notes
127+
128+
- If unable to find a falsy element, both functions return `-1`.
129+
- 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]).
130+
131+
</section>
132+
133+
<!-- /.notes -->
134+
135+
<!-- Package usage examples. -->
136+
137+
<section class="examples">
138+
139+
## Examples
140+
141+
<!-- eslint no-undef: "error" -->
142+
143+
```javascript
144+
var bernoulli = require( '@stdlib/random/array/bernoulli' );
145+
var gindexOfFalsy = require( '@stdlib/blas/ext/base/gindex-of-falsy' );
146+
147+
var x = bernoulli( 10, 0.7, {
148+
'dtype': 'generic'
149+
});
150+
console.log( x );
151+
152+
var idx = gindexOfFalsy( x.length, x, 1 );
153+
console.log( idx );
154+
```
155+
156+
</section>
157+
158+
<!-- /.examples -->
159+
160+
<!-- 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. -->
161+
162+
<section class="references">
163+
164+
</section>
165+
166+
<!-- /.references -->
167+
168+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
169+
170+
<section class="related">
171+
172+
</section>
173+
174+
<!-- /.related -->
175+
176+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
177+
178+
<section class="links">
179+
180+
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
181+
182+
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
183+
184+
</section>
185+
186+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/gindex-of-falsy/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 ones = require( '@stdlib/array/ones' );
27+
var format = require( '@stdlib/string/format' );
28+
var pkg = require( './../package.json' ).name;
29+
var gindexOfFalsy = 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 = ones( len, 'generic' );
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 = gindexOfFalsy( x.length, 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-falsy/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 ones = require( '@stdlib/array/ones' );
27+
var format = require( '@stdlib/string/format' );
28+
var pkg = require( './../package.json' ).name;
29+
var gindexOfFalsy = 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 = ones( len, 'generic' );
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 = gindexOfFalsy( x.length, 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)