feat: add `blas/ext/base/sindex-of` #7318

headlessNode · 2025-06-11T09:06:53Z

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 ---

Progresses #2656 .

Description

What is the purpose of this pull request?

This pull request:

add blas/ext/base/sindexof

Related Issues

Does this pull request have any related issues?

This pull request:

Progresses [RFC]: achieve ndarray API parity with built-in JavaScript arrays #2656

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

--- 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 ---

stdlib-bot · 2025-06-11T09:08:50Z

Coverage Report

Package	Statements	Branches	Functions	Lines
blas/ext/base/sindex-of	$\color{green}174/174$ $\color{green}+100.00\%$	$\color{green}12/12$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}174/174$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

--- 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: na - task: lint_repl_help status: na - 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 ---

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt

lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js

--- 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: na - 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 ---

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js

Signed-off-by: Muhammad Haris <[email protected]>

kgryte · 2025-06-14T00:18:46Z

@headlessNode Would you mind going ahead and adding the C implementation and associated benchmarks, examples, docs, and tests?

kgryte · 2025-06-14T00:20:23Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **searchElement**: element to search the index of.


Suggested change

- **searchElement**: element to search the index of.

- **searchElement**: search element.

kgryte · 2025-06-14T00:20:34Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

+-   **N**: number of indexed elements.
+-   **searchElement**: element to search the index of.
+-   **x**: input [`Float32Array`][@stdlib/array/float32].
+-   **strideX**: index increment.


Suggested change

- **strideX**: index increment.

- **strideX**: stride length.

kgryte · 2025-06-14T00:20:50Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

+-   **x**: input [`Float32Array`][@stdlib/array/float32].
+-   **strideX**: index increment.
+
+If the function is unable to find an element which equals a provided search element, the function returns `-1`.


Suggested change

If the function is unable to find an element which equals a provided search element, the function returns `-1`.

If the function is unable to find a search element, the function returns `-1`.

kgryte · 2025-06-14T00:22:40Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

+var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
+
+var idx = sindexOf( 4, -1.0, x, 2 );
+// returns 6


This is incorrect. N specifies the view length. Here, that "view" is four elements. 6 is the index in the underlying buffer. That is not what we care about in this case.

See also blas/base/isamax.

kgryte · 2025-06-14T00:24:18Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

+
+// Find index...
+var idx = sindexOf( 3, -6.0, x1, 2 );
+// returns 4


Same thing. This return value is incorrect.

kgryte · 2025-06-14T00:24:53Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md

+var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
+
+var idx = sindexOf.ndarray( 3, 3.0, x, 1, x.length-3 );
+// returns 7


This is incorrect.

kgryte · 2025-06-14T00:26:06Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js

+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = sindexOf( x.length, 2.0, x, 1 );


Suggested change

out = sindexOf( x.length, 2.0, x, 1 );

out = sindexOf( x.length, len+1, x, 1 );

2.0 obviously does not make sense here, as then the benchmarks are effectively constant time. You should be benchmarking the worst case scenario (i.e., when you need to search an entire array).

kgryte · 2025-06-14T00:26:51Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js

+		len = pow( 10, i );
+
+		f = createBenchmark( len );
+		bench( pkg+':dtype=float32,len='+len, f );


Why are we including dtype here? Only one dtype is allowed/expected.

Suggested change

bench( pkg+':dtype=float32,len='+len, f );

bench( pkg+':len='+len, f );

kgryte · 2025-06-14T00:27:02Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js

+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = sindexOf( x.length, 2.0, x, 1, 0 );


Suggested change

out = sindexOf( x.length, 2.0, x, 1, 0 );

out = sindexOf( x.length, len+1, x, 1, 0 );

kgryte · 2025-06-14T00:27:15Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js

+		len = pow( 10, i );
+
+		f = createBenchmark( len );
+		bench( pkg+':dtype=float32,len='+len, f );


Suggested change

bench( pkg+':dtype=float32,len='+len, f );

bench( pkg+':len='+len, f );

kgryte · 2025-06-14T00:30:26Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js

+* Returns the index of a specified search element in a single-precision floating-point strided array.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Number} searchElement - number to search index of


Suggested change

* @param {Number} searchElement - number to search index of

* @param {number} searchElement - search element

kgryte · 2025-06-14T00:30:34Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js

+* @param {PositiveInteger} N - number of indexed elements
+* @param {Number} searchElement - number to search index of
+* @param {Float32Array} x - input array
+* @param {integer} strideX - index increment


Suggested change

* @param {integer} strideX - index increment

* @param {integer} strideX - stride length

kgryte · 2025-06-14T00:30:58Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js

+* Returns the index of a specified search element in a single-precision floating-point strided array using alternative indexing semantics.
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {Number} searchElement - number to search index of


Suggested change

* @param {Number} searchElement - number to search index of

* @param {number} searchElement - search element

kgryte · 2025-06-14T00:31:11Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js

+* @param {PositiveInteger} N - number of indexed elements
+* @param {Number} searchElement - number to search index of
+* @param {Float32Array} x - input array
+* @param {integer} strideX - index increment


Suggested change

* @param {integer} strideX - index increment

* @param {integer} strideX - stride length

kgryte · 2025-06-14T00:31:24Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js

+	ix = offsetX;
+	for ( i = 0; i < N; i++ ) {
+		if ( x[ ix ] === searchElement ) {
+			return ix;


Suggested change

return ix;

return i;

kgryte · 2025-06-14T00:32:01Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js

+	t.strictEqual( actual, 3, 'returns expected value' );
+
+	actual = sindexOf( x.length, 3.0, x, -1 );
+	t.strictEqual( actual, 5, 'returns expected value' );


This is incorrect.

kgryte · 2025-06-14T00:32:13Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js

+	t.strictEqual( actual, 1, 'returns expected value' );
+
+	actual = sindexOf( x.length, 2.0, x, -1 );
+	t.strictEqual( actual, 3, 'returns expected value' );


This is incorrect.

kgryte · 2025-06-14T00:32:22Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js

+
+	// Negative stride...
+	actual = sindexOf( x.length, 1.0, x, -1 );
+	t.strictEqual( actual, 1, 'returns expected value' );


This is incorrect.

kgryte · 2025-06-14T00:32:46Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js

+	actual = sindexOf( x.length, 1.0, x, -1, x.length-1 );
+	t.strictEqual( actual, 1, 'returns expected value' );
+
+	actual = sindexOf( x.length, 2.0, x, -2, x.length-1 );
+	t.strictEqual( actual, 3, 'returns expected value' );
+
+	actual = sindexOf( x.length, 1.0, x, -2, x.length-2 );
+	t.strictEqual( actual, 0, 'returns expected value' );


These are all incorrect.

kgryte · 2025-06-14T00:32:58Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js

+	t.strictEqual( actual, 0, 'returns expected value' );
+
+	actual = sindexOf( x.length, 2.0, x, 1, 1 );
+	t.strictEqual( actual, 2, 'returns expected value' );


kgryte · 2025-06-14T00:33:04Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js

+	t.strictEqual( actual, 2, 'returns expected value' );
+
+	actual = sindexOf( x.length, 3.0, x, 1, 2 );
+	t.strictEqual( actual, 4, 'returns expected value' );


kgryte · 2025-06-14T00:33:37Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js

+	var ix;
+	var i;
+
+	if ( N <= 0 || x.length === 0 ) {


Suggested change

if ( N <= 0 || x.length === 0 ) {

if ( N <= 0 ) {

kgryte · 2025-06-14T00:34:15Z

lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js

+tape( 'the function returns `-1` if provided an offset which exceeds the maximum array index', function test( t ) {
+	var actual;
+
+	actual = sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 20 );
+	t.strictEqual( actual, -1, 'returns expected value' );
+
+	t.end();
+});


This test should be removed. In strided array implementations, we don't perform buffer bounds checking.

Again, it would be useful to refer to https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/blas/base/isamax/lib/ndarray.js.

stdlib-bot added the BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). label Jun 11, 2025

headlessNode added Feature Issue or pull request for adding a new feature. GSoC Google Summer of Code. gsoc: 2025 Google Summer of Code (2025). labels Jun 11, 2025

kgryte changed the title ~~feat: add blas/ext/base/sindexof~~ feat: add blas/ext/base/sindex-of Jun 12, 2025