Skip to content

Commit f928b2f

Browse files
headlessNodekgryte
andauthored
feat: add blas/ext/base/ndarray/gfind-last-index
PR-URL: #7786 Ref: #2656 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
1 parent 1880c41 commit f928b2f

File tree

10 files changed

+978
-0
lines changed

10 files changed

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

0 commit comments

Comments
 (0)