Skip to content

Commit 25fd7dd

Browse files
kgrytekgryte
committed
feat: add array/base/last-index-of-same-value
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent e8a96a1 commit 25fd7dd

File tree

10 files changed

+1103
-0
lines changed

10 files changed

+1103
-0
lines changed

‎lib/node_modules/@stdlib/array/base/last-index-of-same-value/README.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
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+
# lastIndexOfSameValue
22+
23+
> Return the index of the last element which equals a provided search element according to the [same value algorithm][@stdlib/assert/is-same-value].
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 lastIndexOfSameValue = require( '@stdlib/array/base/last-index-of-same-value' );
41+
```
42+
43+
#### lastIndexOfSameValue( x, searchElement, fromIndex )
44+
45+
Returns the index of the last element which equals a provided search element according to the [same value algorithm][@stdlib/assert/is-same-value].
46+
47+
```javascript
48+
var x = [ 1, 2, 3, 4, 5, 6 ];
49+
50+
var idx = lastIndexOfSameValue( x, 3, 5 );
51+
// returns 2
52+
```
53+
54+
If the function is unable to find an element which equals a provided search element, the function returns `-1`.
55+
56+
```javascript
57+
var x = [ 1, 2, 3, 4, 5, 6 ];
58+
59+
var idx = lastIndexOfSameValue( x, 7, 5 );
60+
// returns -1
61+
```
62+
63+
To begin searching from a specific index, provide a corresponding `fromIndex` argument.
64+
65+
```javascript
66+
var x = [ 1, 1, 2, 1, 2, 3, 3 ];
67+
68+
var idx = lastIndexOfSameValue( x, 2, 3 );
69+
// returns 2
70+
```
71+
72+
If `fromIndex` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `fromIndex = -1`.
73+
74+
```javascript
75+
var x = [ 1, 1, 2, 1, 2, 3, 3 ];
76+
77+
var idx = lastIndexOfSameValue( x, 2, -4 );
78+
// returns 2
79+
```
80+
81+
</section>
82+
83+
<!-- /.usage -->
84+
85+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
86+
87+
<section class="notes">
88+
89+
## Notes
90+
91+
- The function scans an input array from the starting index to the beginning of the array (i.e., backward).
92+
- When searching for a search element, the function checks for equality using the [same value algorithm][@stdlib/assert/is-same-value]. As a consequence, `NaN` values are considered equal, and `-0` and `+0` are considered distinct.
93+
94+
</section>
95+
96+
<!-- /.notes -->
97+
98+
<!-- Package usage examples. -->
99+
100+
<section class="examples">
101+
102+
## Examples
103+
104+
<!-- eslint no-undef: "error" -->
105+
106+
```javascript
107+
var lastIndexOfSameValue = require( '@stdlib/array/base/last-index-of-same-value' );
108+
109+
var x = [ 'foo', 'bar', 'beep', 'boop', 'foo', 'bar' ];
110+
111+
var idx = lastIndexOfSameValue( x, 'beep', 5 );
112+
// returns 2
113+
114+
idx = lastIndexOfSameValue( x, 'bop', 5 );
115+
// returns -1
116+
117+
idx = lastIndexOfSameValue( x, 'foo', 5 );
118+
// returns 4
119+
120+
idx = lastIndexOfSameValue( x, 'foo', -3 );
121+
// returns 0
122+
123+
idx = lastIndexOfSameValue( x, 'foo', -50 );
124+
// returns -1
125+
```
126+
127+
</section>
128+
129+
<!-- /.examples -->
130+
131+
<!-- 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. -->
132+
133+
<section class="references">
134+
135+
</section>
136+
137+
<!-- /.references -->
138+
139+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
140+
141+
<section class="related">
142+
143+
</section>
144+
145+
<!-- /.related -->
146+
147+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
148+
149+
<section class="links">
150+
151+
[@stdlib/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-value
152+
153+
</section>
154+
155+
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/last-index-of-same-value/benchmark/benchmark.length.js

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
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 pow = require( '@stdlib/math/base/special/pow' );
25+
var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
26+
var zeroTo = require( '@stdlib/array/base/zero-to' );
27+
var pkg = require( './../package.json' ).name;
28+
var lastIndexOfSameValue = require( './../lib' );
29+
30+
31+
// FUNCTIONS //
32+
33+
/**
34+
* Creates a benchmark function.
35+
*
36+
* @private
37+
* @param {PositiveInteger} len - array length
38+
* @returns {Function} benchmark function
39+
*/
40+
function createBenchmark( len ) {
41+
var x = zeroTo( len );
42+
return benchmark;
43+
44+
/**
45+
* Benchmark function.
46+
*
47+
* @private
48+
* @param {Benchmark} b - benchmark instance
49+
*/
50+
function benchmark( b ) {
51+
var out;
52+
var i;
53+
54+
b.tic();
55+
for ( i = 0; i < b.iterations; i++ ) {
56+
out = lastIndexOfSameValue( x, -2, len-1 );
57+
if ( out !== out ) {
58+
b.fail( 'should return an integer' );
59+
}
60+
}
61+
b.toc();
62+
if ( !isInteger( out ) || out >= 0 ) {
63+
b.fail( 'should return an integer' );
64+
}
65+
b.pass( 'benchmark finished' );
66+
b.end();
67+
}
68+
}
69+
70+
71+
// MAIN //
72+
73+
/**
74+
* Main execution sequence.
75+
*
76+
* @private
77+
*/
78+
function main() {
79+
var len;
80+
var min;
81+
var max;
82+
var f;
83+
var i;
84+
85+
min = 1; // 10^min
86+
max = 6; // 10^max
87+
88+
for ( i = min; i <= max; i++ ) {
89+
len = pow( 10, i );
90+
91+
f = createBenchmark( len );
92+
bench( pkg+':dtype=generic,len='+len, f );
93+
}
94+
}
95+
96+
main();

‎lib/node_modules/@stdlib/array/base/last-index-of-same-value/docs/repl.txt

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
{{alias}}( x, searchElement, fromIndex )
3+
Returns the index of the last element which equals a provided search
4+
element according to the same value algorithm.
5+
6+
The function performs a linear scan and returns immediately upon finding a
7+
match.
8+
9+
If unable to find an element which equals a provided search element, the
10+
function returns -1.
11+
12+
The function scans an input array from the starting index to the beginning
13+
of the array (i.e., backward).
14+
15+
Parameters
16+
----------
17+
x: ArrayLikeObject
18+
Input array.
19+
20+
searchElement: any
21+
Search element.
22+
23+
fromIndex: integer
24+
Starting index (inclusive). If less than zero, the starting index is
25+
resolved relative to the last array element, with the last array element
26+
corresponding to `fromIndex = -1`.
27+
28+
Returns
29+
-------
30+
out: integer
31+
Index or -1.
32+
33+
Examples
34+
--------
35+
> var out = {{alias}}( [ 1, 3, 3, 4 ], 3, 3 )
36+
2
37+
38+
See Also
39+
--------
40+

‎lib/node_modules/@stdlib/array/base/last-index-of-same-value/docs/types/index.d.ts

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
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+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { Collection, AccessorArrayLike } from '@stdlib/types/array';
24+
25+
/**
26+
* Returns the index of the last element which equals a provided search element according to the same value algorithm.
27+
*
28+
* ## Notes
29+
*
30+
* - The function scans an input array from the starting index to the beginning of the array (i.e., backward).
31+
* - If unable to find an element which equals a provided search element, the function returns `-1`.
32+
* - If `fromIndex` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `fromIndex = -1`.
33+
*
34+
* @param x - input array
35+
* @param searchElement - search element
36+
* @param fromIndex - starting index (inclusive)
37+
* @returns index
38+
*
39+
* @example
40+
* var x = [ 1, 2, 3, 4 ];
41+
*
42+
* var idx = lastIndexOfSameValue( x, 2, 3 );
43+
* // returns 1
44+
*
45+
* @example
46+
* var Int32Array = require( '@stdlib/array/int32' );
47+
*
48+
* var x = new Int32Array( [ 1, 2, 3, 4 ] );
49+
*
50+
* var idx = lastIndexOfSameValue( x, 2, 3 );
51+
* // returns 1
52+
*/
53+
declare function lastIndexOfSameValue( x: Collection | AccessorArrayLike<unknown>, searchElement: unknown, fromIndex: number ): number;
54+
55+
56+
// EXPORTS //
57+
58+
export = lastIndexOfSameValue;

0 commit comments

Comments
 (0)