Skip to content

Commit c1eefaf

Browse files
headlessNodeheadlessNode
committed
feat: add blas/ext/base/ndarray/gfind-index
1 parent 53c6429 commit c1eefaf

File tree

10 files changed

+991
-0
lines changed

10 files changed

+991
-0
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gfind-index/README.md

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 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+
# gfindIndex
22+
23+
> Return the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function.
24+
25+
<section class="intro">
26+
27+
</section>
28+
29+
<!-- /.intro -->
30+
31+
<section class="usage">
32+
33+
## Usage
34+
35+
```javascript
36+
var gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' );
37+
```
38+
39+
#### gfindIndex( arrays, clbk\[, thisArg] )
40+
41+
Returns the index of the first element in a one-dimensional ndarray which passes a test implemented by a predicate function.
42+
43+
```javascript
44+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
45+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
46+
47+
function isEven( v ) {
48+
return v % 2.0 === 0.0;
49+
}
50+
51+
var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
52+
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
53+
54+
var idx = gfindIndex( [ x ], isEven );
55+
// returns 2
56+
```
57+
58+
If the function is unable to find a search element, the function returns `-1`.
59+
60+
```javascript
61+
var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
62+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
63+
64+
var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
65+
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
66+
67+
var searchElement = scalar2ndarray( 10.0, {
68+
'dtype': 'generic'
69+
});
70+
71+
var fromIndex = scalar2ndarray( 0, {
72+
'dtype': 'generic'
73+
});
74+
75+
var idx = gfindIndex( [ x, searchElement, fromIndex ] );
76+
// returns -1
77+
```
78+
79+
The function has the following parameters:
80+
81+
- **arrays**: array-like object containing a one-dimensional input ndarray.
82+
- **clbk**: callback function.
83+
- **thisArg**: callback execution context (_optional_).
84+
85+
The callback function is provided the following arguments:
86+
87+
- **value**: current array element.
88+
- **idx**: current array element index.
89+
- **array**: the input ndarray.
90+
91+
To set the callback execution context, provide a `thisArg`.
92+
93+
```javascript
94+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
95+
96+
function isEven( v ) {
97+
this.count += 1;
98+
return v % 2.0 === 0.0;
99+
}
100+
101+
var xbuf = [ 1.0, 3.0, 4.0, 2.0 ];
102+
var x = new ndarray( 'generic', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
103+
var ctx = {
104+
'count': 0
105+
};
106+
107+
var v = gfindIndex( [ x ], clbk, ctx );
108+
// returns 2
109+
110+
var count = ctx.count;
111+
// returns 3
112+
```
113+
114+
</section>
115+
116+
<!-- /.usage -->
117+
118+
<section class="notes">
119+
120+
## Notes
121+
122+
- If provided an empty one-dimensional ndarray, the function returns `-1`.
123+
- A provided callback function should return a boolean value.
124+
125+
</section>
126+
127+
<!-- /.notes -->
128+
129+
<section class="examples">
130+
131+
## Examples
132+
133+
<!-- eslint no-undef: "error" -->
134+
135+
```javascript
136+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
137+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
138+
var ndarray2array = require( '@stdlib/ndarray/to-array' );
139+
var gfindIndex = require( '@stdlib/blas/ext/base/ndarray/gfind-index' );
140+
141+
function isEven( v ) {
142+
return v % 2.0 === 0.0;
143+
}
144+
145+
var xbuf = discreteUniform( 10, -100, 100, {
146+
'dtype': 'generic'
147+
});
148+
var x = new ndarray( 'generic', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
149+
console.log( ndarray2array( x ) );
150+
151+
var idx = gfindIndex( [ x ], isEven );
152+
console.log( idx );
153+
```
154+
155+
</section>
156+
157+
<!-- /.examples -->
158+
159+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
160+
161+
<section class="related">
162+
163+
</section>
164+
165+
<!-- /.related -->
166+
167+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
168+
169+
<section class="links">
170+
171+
</section>
172+
173+
<!-- /.links -->

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gfind-index/benchmark/benchmark.js

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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 uniform = require( '@stdlib/random/array/uniform' );
25+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var pow = require( '@stdlib/math/base/special/pow' );
27+
var ndarray = require( '@stdlib/ndarray/base/ctor' );
28+
var pkg = require( './../package.json' ).name;
29+
var gfindIndex = require( './../lib' );
30+
31+
32+
// VARIABLES //
33+
34+
var options = {
35+
'dtype': 'generic'
36+
};
37+
38+
39+
// FUNCTIONS //
40+
41+
/**
42+
* Callback function.
43+
*
44+
* @private
45+
* @param {number} v - array element
46+
* @returns {number} callback result
47+
*/
48+
function clbk( v ) {
49+
return v < 0.0;
50+
}
51+
52+
/**
53+
* Creates a benchmark function.
54+
*
55+
* @private
56+
* @param {PositiveInteger} len - array length
57+
* @returns {Function} benchmark function
58+
*/
59+
function createBenchmark( len ) {
60+
var xbuf;
61+
var x;
62+
63+
xbuf = uniform( len, 0.0, 100.0, options );
64+
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );
65+
66+
return benchmark;
67+
68+
function benchmark( b ) {
69+
var v;
70+
var i;
71+
72+
b.tic();
73+
for ( i = 0; i < b.iterations; i++ ) {
74+
v = gfindIndex( [ x ], clbk );
75+
if ( isnan( v ) ) {
76+
b.fail( 'should not return NaN' );
77+
}
78+
}
79+
b.toc();
80+
if ( isnan( v ) ) {
81+
b.fail( 'should not return NaN' );
82+
}
83+
b.pass( 'benchmark finished' );
84+
b.end();
85+
}
86+
}
87+
88+
89+
// MAIN //
90+
91+
/**
92+
* Main execution sequence.
93+
*
94+
* @private
95+
*/
96+
function main() {
97+
var len;
98+
var min;
99+
var max;
100+
var f;
101+
var i;
102+
103+
min = 1; // 10^min
104+
max = 6; // 10^max
105+
106+
for ( i = min; i <= max; i++ ) {
107+
len = pow( 10, i );
108+
f = createBenchmark( len );
109+
bench( pkg+':len='+len, f );
110+
}
111+
}
112+
113+
main();

‎lib/node_modules/@stdlib/blas/ext/base/ndarray/gfind-index/docs/repl.txt

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
2+
{{alias}}( arrays, clbk[, thisArg] )
3+
Returns the index of the first element in a one-dimensional ndarray which
4+
passes a test implemented by a predicate function.
5+
6+
If provided an empty ndarray, the function returns `-1`.
7+
8+
The callback function is provided three arguments:
9+
10+
- value: current array element.
11+
- index: current array index.
12+
- array: the input ndarray.
13+
14+
The callback function should return a boolean value.
15+
16+
Parameters
17+
----------
18+
arrays: ArrayLikeObject<ndarray>
19+
Array-like object containing a one-dimensional input ndarray.
20+
21+
clbk: Function
22+
Callback function.
23+
24+
thisArg: any (optional)
25+
Callback execution context.
26+
27+
Returns
28+
-------
29+
out: integer
30+
Index.
31+
32+
Examples
33+
--------
34+
> var xbuf = [ 1.0, -2.0, 2.0 ];
35+
> var dt = 'generic';
36+
> var sh = [ xbuf.length ];
37+
> var sx = [ 1 ];
38+
> var ox = 0;
39+
> var ord = 'row-major';
40+
> var x = new {{alias:@stdlib/ndarray/ctor}}( dt, xbuf, sh, sx, ox, ord );
41+
> function f ( v ) { return v % 2.0 === 0.0; };
42+
> {{alias}}( [ x ], f )
43+
1
44+
45+
See Also
46+
--------
47+

0 commit comments

Comments
 (0)