feat: add blas/ext/base/sindex-of

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

@@ -0,0 +1,170 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# sindexOf
+
+> Return the index of a specified search element in a single-precision floating-point strided array.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
+```
+
+#### sindexOf( N, searchElement, x, strideX\[, offsetX ] )
+
+Returns the index of a specified search element in a single-precision floating-point strided array.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
+
+var idx = sindexOf( x.length, 3.0, x, 1 );
+// returns 2
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **searchElement**: element to search the index of.
+-   **x**: input [`Float32Array`][@stdlib/array/float32].
+-   **strideX**: index increment.
+-   **offsetX**: starting index (_optional_).
+
+To begin searching from specific index, provide an `offset` parameter:
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
+
+var idx = sindexOf( x.length, 3.0, x, 1, 5 );
+// returns 7
+```
+
+If both `offset` and `stride` are less than zero, the search begins from the last array element and proceeds towards the first element.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
+
+var idx = sindexOf( x.length, 3.0, x, -1, -2 );
+// returns 2
+```
+
+If the function is unable to find an element which equals a provided search element, the function returns `-1`.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] );
+
+var idx = sindexOf( x.length, 8.0, x, 1 );
+// returns -1
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   When searching for a search element, the function checks for equality using the strict equality operator `===`. As a consequence, `NaN` values are considered distinct, and `-0` and `+0` are considered the same.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' );
+
+var x = discreteUniform( 10, -100, 100, {
+    'dtype': 'float32'
+});
+
+var idx = sindexOf( x.length, 2.0, x, 1 );
+console.log( idx );
+
+idx = sindexOf( x.length, 12.0, x, 2, 5 );
+console.log( idx );
+
+idx = sindexOf( x.length, -57.0, x, 1, -2 );
+console.log( idx );
+
+idx = sindexOf( x.length, 92.0, x, -1, -2 );
+console.log( idx );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,96 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
+var oneTo = require( '@stdlib/array/one-to' );
+var pkg = require( './../package.json' ).name;
+var sindexOf = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = oneTo( len, 'float32' );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = sindexOf( x.length, 2.0, x, 1, 0 );
+			if ( out !== out ) {
+				b.fail( 'should return an integer' );
+			}
+		}
+		b.toc();
+		if ( !isInteger( out ) ) {
+			b.fail( 'should return an integer' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+
+		f = createBenchmark( len );
+		bench( pkg+':dtype=float32,len='+len, f );
+	}
+}
+
+main();

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

@@ -0,0 +1,40 @@
+
+{{alias}}( N, searchElement, x, strideX[, offsetX ] )
+    Returns the index of a specified search element in a single-precision
+    floating-point strided array.
+
+    If unable to find an element which equals a provided search element, the
+    function returns -1.
+
+    Parameters
+    ----------
+    N: integer
+        Number of indexed elements.
+
+    searchElement: number
+        Search element.
+
+    x: Float32Array
+        Input array.
+
+    strideX: integer
+        Index increment.
+
+    offsetX: integer (optional)
+        Starting index (inclusive). If less than zero, the starting index is
+        resolved relative to the last array element, with the last array element
+        corresponding to `offsetX = -1`.
+
+    Returns
+    -------
+    out: integer
+        Index or -1.
+
+    Examples
+    --------
+    > var x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, -1.0, -3.0 ] );
+    > var out = {{alias}}( x.length, 1.0, x, 1 )
+    1
+
+    See Also
+    --------

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

@@ -0,0 +1,48 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Returns the index of a specified search element in a single-precision floating-point strided array.
+*
+* ## Notes
+*
+* -   If unable to find an element which equals a provided search element, the function returns `-1`.
+* -   If `offsetX` is less than zero, the starting index is resolved relative to the last array element, with the last array element corresponding to `offsetX = -1`.
+*
+* @param N - number of indexed elements
+* @param searchElement - search element
+* @param x - input array
+* @param strideX - stride length
+* @param offsetX - starting index
+* @returns index
+*
+* @example
+* var Float32Array = require( '@stdlib/array/float32' );
+* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] );
+*
+* var idx = sindexOf( x.length, 2.0, x, 1 );
+* // returns 1
+*/
+declare function sindexOf( N: number, searchElement: number, x: Float32Array, strideX: number, offsetX?: number ): number;
+
+
+// EXPORTS //
+
+export = sindexOf;