From 864303fddc3a9dfc32b02be7fe140ce9b4771a3f Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Wed, 11 Jun 2025 09:03:12 +0000 Subject: [PATCH 01/11] feat: add index-of --- 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/blas/ext/base/sindex-of/README.md | 170 ++++++++++++++++++ .../sindex-of/benchmark/benchmark.length.js | 96 ++++++++++ .../blas/ext/base/sindex-of/docs/repl.txt | 40 +++++ .../ext/base/sindex-of/docs/types/index.d.ts | 48 +++++ .../ext/base/sindex-of/docs/types/test.ts | 120 +++++++++++++ .../blas/ext/base/sindex-of/examples/index.js | 38 ++++ .../blas/ext/base/sindex-of/lib/index.js | 43 +++++ .../blas/ext/base/sindex-of/lib/main.js | 76 ++++++++ .../blas/ext/base/sindex-of/package.json | 71 ++++++++ .../blas/ext/base/sindex-of/test/test.js | 136 ++++++++++++++ 10 files changed, 838 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md new file mode 100644 index 000000000000..f0b67c770d12 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md @@ -0,0 +1,170 @@ + + +# sindexof + +> Return the index of a specified search element in a single-precision floating-point strided array. + + + +
+ +
+ + + + + +
+ +## 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`. + +```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 +``` + +
+ + + + + +
+ +## 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. + +
+ + + + + +
+ +## Examples + + + +```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 ); +``` + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js new file mode 100644 index 000000000000..658b3d128433 --- /dev/null +++ b/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(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt new file mode 100644 index 000000000000..44320ba43507 --- /dev/null +++ b/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 + -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts new file mode 100644 index 000000000000..ab586fc95d77 --- /dev/null +++ b/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; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts new file mode 100644 index 000000000000..785ccd5c7d6c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts @@ -0,0 +1,120 @@ +/* +* @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. +*/ + +import sindexof = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexof( x.length, 2.0, x, 1 ); // $ExpectType number + sindexof( x.length, 2.0, x, 1, 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexof( '1', 2.0, x, 1 ); // $ExpectError + sindexof( true, 2.0, x, 1 ); // $ExpectError + sindexof( false, 2.0, x, 1 ); // $ExpectError + sindexof( null, 2.0, x, 1 ); // $ExpectError + sindexof( {}, 2.0, x, 1 ); // $ExpectError + + sindexof( '1', 2.0, x, 1, 1 ); // $ExpectError + sindexof( true, 2.0, x, 1, 1 ); // $ExpectError + sindexof( false, 2.0, x, 1, 1 ); // $ExpectError + sindexof( null, 2.0, x, 1, 1 ); // $ExpectError + sindexof( {}, 2.0, x, 1, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexof( x.length, '1', x, 1 ); // $ExpectError + sindexof( x.length, true, x, 1 ); // $ExpectError + sindexof( x.length, false, x, 1 ); // $ExpectError + sindexof( x.length, null, x, 1 ); // $ExpectError + sindexof( x.length, {}, x, 1 ); // $ExpectError + + sindexof( x.length, '1', x, 1, 1 ); // $ExpectError + sindexof( x.length, true, x, 1, 1 ); // $ExpectError + sindexof( x.length, false, x, 1, 1 ); // $ExpectError + sindexof( x.length, null, x, 1, 1 ); // $ExpectError + sindexof( x.length, {}, x, 1, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a Float32Array... +{ + sindexof( x.length, 1.0, '1', 1 ); // $ExpectError + sindexof( x.length, 1.0, true, 1 ); // $ExpectError + sindexof( x.length, 1.0, false, 1 ); // $ExpectError + sindexof( x.length, 1.0, null, 1 ); // $ExpectError + sindexof( x.length, 1.0, {}, 1 ); // $ExpectError + + sindexof( x.length, 1.0, '1', 1, 1 ); // $ExpectError + sindexof( x.length, 1.0, true, 1, 1 ); // $ExpectError + sindexof( x.length, 1.0, false, 1, 1 ); // $ExpectError + sindexof( x.length, 1.0, null, 1, 1 ); // $ExpectError + sindexof( x.length, 1.0, {}, 1, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexof( x.length, 2.0, x, '1' ); // $ExpectError + sindexof( x.length, 2.0, x, true ); // $ExpectError + sindexof( x.length, 2.0, x, false ); // $ExpectError + sindexof( x.length, 2.0, x, null ); // $ExpectError + sindexof( x.length, 2.0, x, {} ); // $ExpectError + + sindexof( x.length, 2.0, x, '1', 1 ); // $ExpectError + sindexof( x.length, 2.0, x, true, 1 ); // $ExpectError + sindexof( x.length, 2.0, x, false, 1 ); // $ExpectError + sindexof( x.length, 2.0, x, null, 1 ); // $ExpectError + sindexof( x.length, 2.0, x, {}, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexof( x.length, 2.0, x, 1, '1' ); // $ExpectError + sindexof( x.length, 2.0, x, 1, true ); // $ExpectError + sindexof( x.length, 2.0, x, 1, false ); // $ExpectError + sindexof( x.length, 2.0, x, 1, null ); // $ExpectError + sindexof( x.length, 2.0, x, 1, {} ); // $ExpectError + + sindexof( x.length, 2.0, x, 1, '1' ); // $ExpectError + sindexof( x.length, 2.0, x, 1, true ); // $ExpectError + sindexof( x.length, 2.0, x, 1, false ); // $ExpectError + sindexof( x.length, 2.0, x, 1, null ); // $ExpectError + sindexof( x.length, 2.0, x, 1, {} ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + sindexof(); // $ExpectError + sindexof( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError + sindexof( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 1, {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js new file mode 100644 index 000000000000..8b1057bf33cd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js @@ -0,0 +1,38 @@ +/** +* @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'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var sindexof = require( './../lib' ); + +var x = discreteUniform( 10, -100, 100, { + 'dtype': 'float32' +}); +console.log( x ); +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 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js new file mode 100644 index 000000000000..cdf2828cc443 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js @@ -0,0 +1,43 @@ +/** +* @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'; + +/** +* Return the index of a specified search element in a single-precision floating-point strided array. +* +* @module @stdlib/blas/ext/base/sindex-of +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var sindexof = require( '@stdlib/blas/ext/base/sindex-of' ); +* +* 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 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js new file mode 100644 index 000000000000..f56f15cbebcd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js @@ -0,0 +1,76 @@ +/** +* @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'; + +// MAIN // + +/** +* 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 +* @param {Float32Array} x - input array +* @param {integer} strideX - index increment +* @param {NonNegativeInteger} [offsetX] - starting index +* @returns {integer} index +* +* @example +* 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 +*/ +function sindexof( N, searchElement, x, strideX, offsetX ) { + var ix; + var i; + + if ( N <= 0 || x.length === 0 ) { + return -1; + } + + if ( offsetX === void 0 ) { + if ( strideX < 0 ) { + ix = x.length - 1; + } else { + ix = 0; + } + } else if ( offsetX < 0 ) { + ix = x.length + offsetX; + } else { + ix = offsetX; + } + + for ( i = 0; i < N; i++ ) { + if ( x[ ix ] === searchElement ) { + return ix; + } + ix += strideX; + if ( ix < 0 || ix >= x.length ) { + break; + } + } + return -1; +} + + +// EXPORTS // + +module.exports = sindexof; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/package.json b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/package.json new file mode 100644 index 000000000000..e69899f383eb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/package.json @@ -0,0 +1,71 @@ +{ + "name": "@stdlib/blas/ext/base/sindex-of", + "version": "0.0.0", + "description": "Return the index of a specified search element in a single-precision floating-point strided array.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdtypes", + "types", + "data", + "blas", + "structure", + "array", + "ndarray", + "single", + "strided", + "float", + "float32", + "float32array", + "search", + "find", + "scan", + "locate", + "index" + ] +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js new file mode 100644 index 000000000000..f17d8052e1ec --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js @@ -0,0 +1,136 @@ +/** +* @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 tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var sindexof = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof sindexof, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the first index of an element which equals a provided search element', function test( t ) { + var actual; + var x; + + x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); + + actual = sindexof( x.length, 1.0, x, 1 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexof( x.length, 2.0, x, 1 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + actual = sindexof( x.length, 3.0, x, 1 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + // Nonnegative offset and stride... + actual = sindexof( x.length, 1.0, x, 1, 1 ); + t.strictEqual( actual, 1, 'returns expected value' ); + + actual = sindexof( x.length, 2.0, x, 1, 3 ); + t.strictEqual( actual, 3, 'returns expected value' ); + + actual = sindexof( x.length, 3.0, x, 1, 5 ); + t.strictEqual( actual, 5, 'returns expected value' ); + + // Negative offset and Nonnegative stride... + actual = sindexof( x.length, 1.0, x, 1, -6 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexof( x.length, 3.0, x, 1, -3 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + actual = sindexof( x.length, 1.0, x, 1, -5 ); + t.strictEqual( actual, 1, 'returns expected value' ); + + actual = sindexof( x.length, 3.0, x, 1, -1 ); + t.strictEqual( actual, 5, 'returns expected value' ); + + // Negative offset and Negative stride... + actual = sindexof( x.length, 1.0, x, -1, -1 ); + t.strictEqual( actual, 1, 'returns expected value' ); + + actual = sindexof( x.length, 3.0, x, -1, -1 ); + t.strictEqual( actual, 5, 'returns expected value' ); + + actual = sindexof( x.length, 1.0, x, -1, -6 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexof( x.length, 2.0, x, -1, -2 ); + t.strictEqual( actual, 3, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided an empty array', function test( t ) { + var actual; + + actual = sindexof( 1, 0.0, new Float32Array( [] ), 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexof( 1, 0.0, new Float32Array( [] ), 0, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { + var actual; + + actual = sindexof( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexof( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided a search element equal to `NaN`', function test( t ) { + var actual; + + actual = sindexof( 1, NaN, new Float32Array( [ NaN ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexof( 1, NaN, new Float32Array( [ NaN ] ), 1, 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided an offset which exceeds the maximum array index', function test( t ) { + var actual; + var x; + + x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + actual = sindexof( x.length, 2.0, x, 1, 20 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); From ee87e2b3d8aea8d258f0a084f75879493a4934df Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Thu, 12 Jun 2025 05:05:02 +0000 Subject: [PATCH 02/11] fix: function name --- 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 --- --- .../@stdlib/blas/ext/base/sindex-of/README.md | 26 ++-- .../sindex-of/benchmark/benchmark.length.js | 4 +- .../ext/base/sindex-of/docs/types/index.d.ts | 6 +- .../ext/base/sindex-of/docs/types/test.ts | 122 +++++++++--------- .../blas/ext/base/sindex-of/examples/index.js | 10 +- .../blas/ext/base/sindex-of/lib/index.js | 4 +- .../blas/ext/base/sindex-of/lib/main.js | 6 +- .../blas/ext/base/sindex-of/test/test.js | 46 +++---- 8 files changed, 112 insertions(+), 112 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md index f0b67c770d12..a623aa6ecedf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md @@ -18,7 +18,7 @@ limitations under the License. --> -# sindexof +# sindexOf > Return the index of a specified search element in a single-precision floating-point strided array. @@ -37,10 +37,10 @@ limitations under the License. ## Usage ```javascript -var sindexof = require( '@stdlib/blas/ext/base/sindex-of' ); +var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' ); ``` -#### sindexof( N, searchElement, x, strideX\[, offsetX ] ) +#### sindexOf( N, searchElement, x, strideX\[, offsetX ] ) Returns the index of a specified search element in a single-precision floating-point strided array. @@ -49,7 +49,7 @@ 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 ); +var idx = sindexOf( x.length, 3.0, x, 1 ); // returns 2 ``` @@ -61,14 +61,14 @@ The function has the following parameters: - **strideX**: index increment. - **offsetX**: starting index (_optional_). -To begin searching from specific index, provide an `offset`. +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 ); +var idx = sindexOf( x.length, 3.0, x, 1, 5 ); // returns 7 ``` @@ -79,7 +79,7 @@ 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 ); +var idx = sindexOf( x.length, 3.0, x, -1, -2 ); // returns 2 ``` @@ -90,7 +90,7 @@ 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 ); +var idx = sindexOf( x.length, 8.0, x, 1 ); // returns -1 ``` @@ -120,22 +120,22 @@ var idx = sindexof( x.length, 8.0, x, 1 ); ```javascript var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var sindexof = require( '@stdlib/blas/ext/base/sindex-of' ); +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 ); +var idx = sindexOf( x.length, 2.0, x, 1 ); console.log( idx ); -idx = sindexof( x.length, 12.0, x, 2, 5 ); +idx = sindexOf( x.length, 12.0, x, 2, 5 ); console.log( idx ); -idx = sindexof( x.length, -57.0, x, 1, -2 ); +idx = sindexOf( x.length, -57.0, x, 1, -2 ); console.log( idx ); -idx = sindexof( x.length, 92.0, x, -1, -2 ); +idx = sindexOf( x.length, 92.0, x, -1, -2 ); console.log( idx ); ``` diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js index 658b3d128433..14abcb83f323 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js @@ -25,7 +25,7 @@ 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' ); +var sindexOf = require( './../lib' ); // FUNCTIONS // @@ -53,7 +53,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = sindexof( x.length, 2.0, x, 1, 0 ); + out = sindexOf( x.length, 2.0, x, 1, 0 ); if ( out !== out ) { b.fail( 'should return an integer' ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts index ab586fc95d77..9cb02e6ebcad 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts @@ -37,12 +37,12 @@ * 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 ); +* 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; +declare function sindexOf( N: number, searchElement: number, x: Float32Array, strideX: number, offsetX?: number ): number; // EXPORTS // -export = sindexof; +export = sindexOf; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts index 785ccd5c7d6c..ceb50957bab0 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts @@ -16,7 +16,7 @@ * limitations under the License. */ -import sindexof = require( './index' ); +import sindexOf = require( './index' ); // TESTS // @@ -25,96 +25,96 @@ import sindexof = require( './index' ); { var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - sindexof( x.length, 2.0, x, 1 ); // $ExpectType number - sindexof( x.length, 2.0, x, 1, 1 ); // $ExpectType number + sindexOf( x.length, 2.0, x, 1 ); // $ExpectType number + sindexOf( x.length, 2.0, x, 1, 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... { var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - sindexof( '1', 2.0, x, 1 ); // $ExpectError - sindexof( true, 2.0, x, 1 ); // $ExpectError - sindexof( false, 2.0, x, 1 ); // $ExpectError - sindexof( null, 2.0, x, 1 ); // $ExpectError - sindexof( {}, 2.0, x, 1 ); // $ExpectError - - sindexof( '1', 2.0, x, 1, 1 ); // $ExpectError - sindexof( true, 2.0, x, 1, 1 ); // $ExpectError - sindexof( false, 2.0, x, 1, 1 ); // $ExpectError - sindexof( null, 2.0, x, 1, 1 ); // $ExpectError - sindexof( {}, 2.0, x, 1, 1 ); // $ExpectError + sindexOf( '1', 2.0, x, 1 ); // $ExpectError + sindexOf( true, 2.0, x, 1 ); // $ExpectError + sindexOf( false, 2.0, x, 1 ); // $ExpectError + sindexOf( null, 2.0, x, 1 ); // $ExpectError + sindexOf( {}, 2.0, x, 1 ); // $ExpectError + + sindexOf( '1', 2.0, x, 1, 1 ); // $ExpectError + sindexOf( true, 2.0, x, 1, 1 ); // $ExpectError + sindexOf( false, 2.0, x, 1, 1 ); // $ExpectError + sindexOf( null, 2.0, x, 1, 1 ); // $ExpectError + sindexOf( {}, 2.0, x, 1, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a second argument which is not a number... { var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - sindexof( x.length, '1', x, 1 ); // $ExpectError - sindexof( x.length, true, x, 1 ); // $ExpectError - sindexof( x.length, false, x, 1 ); // $ExpectError - sindexof( x.length, null, x, 1 ); // $ExpectError - sindexof( x.length, {}, x, 1 ); // $ExpectError - - sindexof( x.length, '1', x, 1, 1 ); // $ExpectError - sindexof( x.length, true, x, 1, 1 ); // $ExpectError - sindexof( x.length, false, x, 1, 1 ); // $ExpectError - sindexof( x.length, null, x, 1, 1 ); // $ExpectError - sindexof( x.length, {}, x, 1, 1 ); // $ExpectError + sindexOf( x.length, '1', x, 1 ); // $ExpectError + sindexOf( x.length, true, x, 1 ); // $ExpectError + sindexOf( x.length, false, x, 1 ); // $ExpectError + sindexOf( x.length, null, x, 1 ); // $ExpectError + sindexOf( x.length, {}, x, 1 ); // $ExpectError + + sindexOf( x.length, '1', x, 1, 1 ); // $ExpectError + sindexOf( x.length, true, x, 1, 1 ); // $ExpectError + sindexOf( x.length, false, x, 1, 1 ); // $ExpectError + sindexOf( x.length, null, x, 1, 1 ); // $ExpectError + sindexOf( x.length, {}, x, 1, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a third argument which is not a Float32Array... { - sindexof( x.length, 1.0, '1', 1 ); // $ExpectError - sindexof( x.length, 1.0, true, 1 ); // $ExpectError - sindexof( x.length, 1.0, false, 1 ); // $ExpectError - sindexof( x.length, 1.0, null, 1 ); // $ExpectError - sindexof( x.length, 1.0, {}, 1 ); // $ExpectError - - sindexof( x.length, 1.0, '1', 1, 1 ); // $ExpectError - sindexof( x.length, 1.0, true, 1, 1 ); // $ExpectError - sindexof( x.length, 1.0, false, 1, 1 ); // $ExpectError - sindexof( x.length, 1.0, null, 1, 1 ); // $ExpectError - sindexof( x.length, 1.0, {}, 1, 1 ); // $ExpectError + sindexOf( x.length, 1.0, '1', 1 ); // $ExpectError + sindexOf( x.length, 1.0, true, 1 ); // $ExpectError + sindexOf( x.length, 1.0, false, 1 ); // $ExpectError + sindexOf( x.length, 1.0, null, 1 ); // $ExpectError + sindexOf( x.length, 1.0, {}, 1 ); // $ExpectError + + sindexOf( x.length, 1.0, '1', 1, 1 ); // $ExpectError + sindexOf( x.length, 1.0, true, 1, 1 ); // $ExpectError + sindexOf( x.length, 1.0, false, 1, 1 ); // $ExpectError + sindexOf( x.length, 1.0, null, 1, 1 ); // $ExpectError + sindexOf( x.length, 1.0, {}, 1, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a fourth argument which is not a number... { var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - sindexof( x.length, 2.0, x, '1' ); // $ExpectError - sindexof( x.length, 2.0, x, true ); // $ExpectError - sindexof( x.length, 2.0, x, false ); // $ExpectError - sindexof( x.length, 2.0, x, null ); // $ExpectError - sindexof( x.length, 2.0, x, {} ); // $ExpectError - - sindexof( x.length, 2.0, x, '1', 1 ); // $ExpectError - sindexof( x.length, 2.0, x, true, 1 ); // $ExpectError - sindexof( x.length, 2.0, x, false, 1 ); // $ExpectError - sindexof( x.length, 2.0, x, null, 1 ); // $ExpectError - sindexof( x.length, 2.0, x, {}, 1 ); // $ExpectError + sindexOf( x.length, 2.0, x, '1' ); // $ExpectError + sindexOf( x.length, 2.0, x, true ); // $ExpectError + sindexOf( x.length, 2.0, x, false ); // $ExpectError + sindexOf( x.length, 2.0, x, null ); // $ExpectError + sindexOf( x.length, 2.0, x, {} ); // $ExpectError + + sindexOf( x.length, 2.0, x, '1', 1 ); // $ExpectError + sindexOf( x.length, 2.0, x, true, 1 ); // $ExpectError + sindexOf( x.length, 2.0, x, false, 1 ); // $ExpectError + sindexOf( x.length, 2.0, x, null, 1 ); // $ExpectError + sindexOf( x.length, 2.0, x, {}, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a fifth argument which is not a number... { var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - sindexof( x.length, 2.0, x, 1, '1' ); // $ExpectError - sindexof( x.length, 2.0, x, 1, true ); // $ExpectError - sindexof( x.length, 2.0, x, 1, false ); // $ExpectError - sindexof( x.length, 2.0, x, 1, null ); // $ExpectError - sindexof( x.length, 2.0, x, 1, {} ); // $ExpectError - - sindexof( x.length, 2.0, x, 1, '1' ); // $ExpectError - sindexof( x.length, 2.0, x, 1, true ); // $ExpectError - sindexof( x.length, 2.0, x, 1, false ); // $ExpectError - sindexof( x.length, 2.0, x, 1, null ); // $ExpectError - sindexof( x.length, 2.0, x, 1, {} ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, '1' ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, true ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, false ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, null ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, {} ); // $ExpectError + + sindexOf( x.length, 2.0, x, 1, '1' ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, true ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, false ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, null ); // $ExpectError + sindexOf( x.length, 2.0, x, 1, {} ); // $ExpectError } // The compiler throws an error if the function is provided an unsupported number of arguments... { - sindexof(); // $ExpectError - sindexof( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError - sindexof( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 1, {} ); // $ExpectError + sindexOf(); // $ExpectError + sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError + sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 1, {} ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js index 8b1057bf33cd..bf32f004b19d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js @@ -19,20 +19,20 @@ 'use strict'; var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var sindexof = require( './../lib' ); +var sindexOf = require( './../lib' ); var x = discreteUniform( 10, -100, 100, { 'dtype': 'float32' }); console.log( x ); -var idx = sindexof( x.length, 2.0, x, 1 ); +var idx = sindexOf( x.length, 2.0, x, 1 ); console.log( idx ); -idx = sindexof( x.length, 12.0, x, 2, 5 ); +idx = sindexOf( x.length, 12.0, x, 2, 5 ); console.log( idx ); -idx = sindexof( x.length, -57.0, x, 1, -2 ); +idx = sindexOf( x.length, -57.0, x, 1, -2 ); console.log( idx ); -idx = sindexof( x.length, 92.0, x, -1, -2 ); +idx = sindexOf( x.length, 92.0, x, -1, -2 ); console.log( idx ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js index cdf2828cc443..0f5abe026177 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js @@ -25,11 +25,11 @@ * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var sindexof = require( '@stdlib/blas/ext/base/sindex-of' ); +* var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' ); * * 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 ); +* var idx = sindexOf( x.length, 3.0, x, 1 ); * // returns 2 */ diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js index f56f15cbebcd..0925cc617f65 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js @@ -35,10 +35,10 @@ * * 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 ); +* var idx = sindexOf( x.length, 3.0, x, 1 ); * // returns 2 */ -function sindexof( N, searchElement, x, strideX, offsetX ) { +function sindexOf( N, searchElement, x, strideX, offsetX ) { var ix; var i; @@ -73,4 +73,4 @@ function sindexof( N, searchElement, x, strideX, offsetX ) { // EXPORTS // -module.exports = sindexof; +module.exports = sindexOf; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js index f17d8052e1ec..280e879b2ebf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js @@ -22,14 +22,14 @@ var tape = require( 'tape' ); var Float32Array = require( '@stdlib/array/float32' ); -var sindexof = require( './../lib' ); +var sindexOf = require( './../lib' ); // TESTS // tape( 'main export is a function', function test( t ) { t.ok( true, __filename ); - t.strictEqual( typeof sindexof, 'function', 'main export is a function' ); + t.strictEqual( typeof sindexOf, 'function', 'main export is a function' ); t.end(); }); @@ -39,49 +39,49 @@ tape( 'the function returns the first index of an element which equals a provide x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); - actual = sindexof( x.length, 1.0, x, 1 ); + actual = sindexOf( x.length, 1.0, x, 1 ); t.strictEqual( actual, 0, 'returns expected value' ); - actual = sindexof( x.length, 2.0, x, 1 ); + actual = sindexOf( x.length, 2.0, x, 1 ); t.strictEqual( actual, 2, 'returns expected value' ); - actual = sindexof( x.length, 3.0, x, 1 ); + actual = sindexOf( x.length, 3.0, x, 1 ); t.strictEqual( actual, 4, 'returns expected value' ); // Nonnegative offset and stride... - actual = sindexof( x.length, 1.0, x, 1, 1 ); + actual = sindexOf( x.length, 1.0, x, 1, 1 ); t.strictEqual( actual, 1, 'returns expected value' ); - actual = sindexof( x.length, 2.0, x, 1, 3 ); + actual = sindexOf( x.length, 2.0, x, 1, 3 ); t.strictEqual( actual, 3, 'returns expected value' ); - actual = sindexof( x.length, 3.0, x, 1, 5 ); + actual = sindexOf( x.length, 3.0, x, 1, 5 ); t.strictEqual( actual, 5, 'returns expected value' ); // Negative offset and Nonnegative stride... - actual = sindexof( x.length, 1.0, x, 1, -6 ); + actual = sindexOf( x.length, 1.0, x, 1, -6 ); t.strictEqual( actual, 0, 'returns expected value' ); - actual = sindexof( x.length, 3.0, x, 1, -3 ); + actual = sindexOf( x.length, 3.0, x, 1, -3 ); t.strictEqual( actual, 4, 'returns expected value' ); - actual = sindexof( x.length, 1.0, x, 1, -5 ); + actual = sindexOf( x.length, 1.0, x, 1, -5 ); t.strictEqual( actual, 1, 'returns expected value' ); - actual = sindexof( x.length, 3.0, x, 1, -1 ); + actual = sindexOf( x.length, 3.0, x, 1, -1 ); t.strictEqual( actual, 5, 'returns expected value' ); // Negative offset and Negative stride... - actual = sindexof( x.length, 1.0, x, -1, -1 ); + actual = sindexOf( x.length, 1.0, x, -1, -1 ); t.strictEqual( actual, 1, 'returns expected value' ); - actual = sindexof( x.length, 3.0, x, -1, -1 ); + actual = sindexOf( x.length, 3.0, x, -1, -1 ); t.strictEqual( actual, 5, 'returns expected value' ); - actual = sindexof( x.length, 1.0, x, -1, -6 ); + actual = sindexOf( x.length, 1.0, x, -1, -6 ); t.strictEqual( actual, 0, 'returns expected value' ); - actual = sindexof( x.length, 2.0, x, -1, -2 ); + actual = sindexOf( x.length, 2.0, x, -1, -2 ); t.strictEqual( actual, 3, 'returns expected value' ); t.end(); @@ -90,10 +90,10 @@ tape( 'the function returns the first index of an element which equals a provide tape( 'the function returns `-1` if provided an empty array', function test( t ) { var actual; - actual = sindexof( 1, 0.0, new Float32Array( [] ), 0 ); + actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0 ); t.strictEqual( actual, -1, 'returns expected value' ); - actual = sindexof( 1, 0.0, new Float32Array( [] ), 0, 0 ); + actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0, 0 ); t.strictEqual( actual, -1, 'returns expected value' ); t.end(); @@ -102,10 +102,10 @@ tape( 'the function returns `-1` if provided an empty array', function test( t ) tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { var actual; - actual = sindexof( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + actual = sindexOf( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); t.strictEqual( actual, -1, 'returns expected value' ); - actual = sindexof( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + actual = sindexOf( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); t.strictEqual( actual, -1, 'returns expected value' ); t.end(); @@ -114,10 +114,10 @@ tape( 'the function returns `-1` if provided `N` parameter is less than or equal tape( 'the function returns `-1` if provided a search element equal to `NaN`', function test( t ) { var actual; - actual = sindexof( 1, NaN, new Float32Array( [ NaN ] ), 1 ); + actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1 ); t.strictEqual( actual, -1, 'returns expected value' ); - actual = sindexof( 1, NaN, new Float32Array( [ NaN ] ), 1, 1 ); + actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1, 1 ); t.strictEqual( actual, -1, 'returns expected value' ); t.end(); @@ -129,7 +129,7 @@ tape( 'the function returns `-1` if provided an offset which exceeds the maximum x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - actual = sindexof( x.length, 2.0, x, 1, 20 ); + actual = sindexOf( x.length, 2.0, x, 1, 20 ); t.strictEqual( actual, -1, 'returns expected value' ); t.end(); From 933e03caed43ad89feee4949911747c9ccf87e41 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Fri, 13 Jun 2025 12:11:55 +0000 Subject: [PATCH 03/11] fix: apply suggestions from code review --- 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 --- --- .../@stdlib/blas/ext/base/sindex-of/README.md | 66 ++++++++---- .../sindex-of/benchmark/benchmark.length.js | 2 +- .../sindex-of/benchmark/benchmark.ndarray.js | 96 +++++++++++++++++ .../blas/ext/base/sindex-of/docs/repl.txt | 53 +++++++-- .../ext/base/sindex-of/docs/types/index.d.ts | 58 ++++++++-- .../ext/base/sindex-of/docs/types/test.ts | 101 +++++++++++------ .../blas/ext/base/sindex-of/examples/index.js | 10 +- .../blas/ext/base/sindex-of/lib/index.js | 16 +++ .../blas/ext/base/sindex-of/lib/main.js | 39 ++----- .../blas/ext/base/sindex-of/lib/ndarray.js | 62 +++++++++++ .../blas/ext/base/sindex-of/test/test.js | 102 +----------------- .../blas/ext/base/sindex-of/test/test.main.js | 96 +++++++++++++++++ .../ext/base/sindex-of/test/test.ndarray.js | 102 ++++++++++++++++++ 13 files changed, 595 insertions(+), 208 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md index a623aa6ecedf..b795a9c0401d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md @@ -40,7 +40,7 @@ limitations under the License. var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' ); ``` -#### sindexOf( N, searchElement, x, strideX\[, offsetX ] ) +#### sindexOf( N, searchElement, x, strideX ) Returns the index of a specified search element in a single-precision floating-point strided array. @@ -59,39 +59,71 @@ The function has the following parameters: - **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: +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, 3.0, x, 1, 5 ); -// returns 7 +var idx = sindexOf( x.length, 8.0, x, 1 ); +// returns -1 +``` + +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to search every other 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( 4, -1.0, x, 2 ); +// returns 6 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + +```javascript +var Float32Array = require( '@stdlib/array/float32' ); + +// Initial array... +var x0 = new Float32Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); + +// Create an offset view... +var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +// Find index... +var idx = sindexOf( 3, -6.0, x1, 2 ); +// returns 4 ``` -If both `offset` and `stride` are less than zero, the search begins from the last array element and proceeds towards the first element. +#### sindexOf.ndarray( N, searchElement, x, strideX, offsetX ) + +Returns the index of a specified search element in a single-precision floating-point strided array using alternative indexing semantics. ```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 ); +var idx = sindexOf.ndarray( x.length, 3.0, x, 1, 0 ); // returns 2 ``` -If the function is unable to find an element which equals a provided search element, the function returns `-1`. +The function has the following additional parameters: + +- **offsetX**: starting index. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of the 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, 8.0, x, 1 ); -// returns -1 +var idx = sindexOf.ndarray( 3, 3.0, x, 1, x.length-3 ); +// returns 7 ``` @@ -125,17 +157,9 @@ var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' ); var x = discreteUniform( 10, -100, 100, { 'dtype': 'float32' }); +console.log( x ); -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 ); +var idx = sindexOf( x.length, 80.0, x, 1 ); console.log( idx ); ``` @@ -165,6 +189,8 @@ console.log( idx ); [@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32 +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js index 14abcb83f323..abefd692a869 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js @@ -53,7 +53,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = sindexOf( x.length, 2.0, x, 1, 0 ); + out = sindexOf( x.length, 2.0, x, 1 ); if ( out !== out ) { b.fail( 'should return an integer' ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..55751f4b0497 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.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/ndarray.js' ); + + +// 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(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt index 44320ba43507..fbbbf22c3100 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt @@ -1,10 +1,15 @@ -{{alias}}( N, searchElement, x, strideX[, offsetX ] ) +{{alias}}( N, searchElement, x, strideX ) 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. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use a typed + array view. + + if `N <= 0`, the function returns `-1`. Parameters ---------- @@ -20,11 +25,6 @@ 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 @@ -36,5 +36,42 @@ > var out = {{alias}}( x.length, 1.0, x, 1 ) 1 + +{{alias}}( N, searchElement, x, strideX, offsetX ) + Returns the index of a specified search element in a single-precision + floating-point strided array using alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameter supports indexing semantics based on a + starting index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + searchElement: number + Search element. + + x: Float32Array + Input array. + + strideX: integer + Index increment. + + offsetX: integer + Starting index. + + 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}}.ndarray( x.length, 1.0, x, 1, 0 ) + 1 + See Also -------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts index 9cb02e6ebcad..2c1f432f7528 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/index.d.ts @@ -19,18 +19,55 @@ // TypeScript Version: 4.1 /** -* Returns the index of a specified search element in a single-precision floating-point strided array. -* -* ## Notes +* Interface describing `sindexOf` * -* - 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`. +*/ +interface Routine { + /** + * Returns the index of a specified search element in a single-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param searchElement - search element + * @param x - input array + * @param strideX - stride length + * @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 + */ + ( N: number, searchElement: number, x: Float32Array, strideX: number ): number; + + /** + * Returns the index of a specified search element in a single-precision floating-point strided array using alternative indexing semantics. + * + * @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.ndarray( x.length, 2.0, x, 1, 0 ); + * // returns 1 + */ + ndarray( N: number, searchElement: number, x: Float32Array, strideX: number, offsetX: number ): number; +} + +/** +* Returns the index of a specified search element in a single-precision floating-point strided array. * * @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 @@ -39,8 +76,15 @@ * * var idx = sindexOf( x.length, 2.0, x, 1 ); * // returns 1 +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var x = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); +* +* var idx = sindexOf.ndarray( x.length, 2.0, x, 1, 0 ); +* // returns 1 */ -declare function sindexOf( N: number, searchElement: number, x: Float32Array, strideX: number, offsetX?: number ): number; +declare var sindexOf: Routine; // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts index ceb50957bab0..2296d7f8838d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/types/test.ts @@ -26,7 +26,6 @@ import sindexOf = require( './index' ); var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); sindexOf( x.length, 2.0, x, 1 ); // $ExpectType number - sindexOf( x.length, 2.0, x, 1, 1 ); // $ExpectType number } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -38,12 +37,6 @@ import sindexOf = require( './index' ); sindexOf( false, 2.0, x, 1 ); // $ExpectError sindexOf( null, 2.0, x, 1 ); // $ExpectError sindexOf( {}, 2.0, x, 1 ); // $ExpectError - - sindexOf( '1', 2.0, x, 1, 1 ); // $ExpectError - sindexOf( true, 2.0, x, 1, 1 ); // $ExpectError - sindexOf( false, 2.0, x, 1, 1 ); // $ExpectError - sindexOf( null, 2.0, x, 1, 1 ); // $ExpectError - sindexOf( {}, 2.0, x, 1, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a second argument which is not a number... @@ -55,12 +48,6 @@ import sindexOf = require( './index' ); sindexOf( x.length, false, x, 1 ); // $ExpectError sindexOf( x.length, null, x, 1 ); // $ExpectError sindexOf( x.length, {}, x, 1 ); // $ExpectError - - sindexOf( x.length, '1', x, 1, 1 ); // $ExpectError - sindexOf( x.length, true, x, 1, 1 ); // $ExpectError - sindexOf( x.length, false, x, 1, 1 ); // $ExpectError - sindexOf( x.length, null, x, 1, 1 ); // $ExpectError - sindexOf( x.length, {}, x, 1, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a third argument which is not a Float32Array... @@ -70,12 +57,6 @@ import sindexOf = require( './index' ); sindexOf( x.length, 1.0, false, 1 ); // $ExpectError sindexOf( x.length, 1.0, null, 1 ); // $ExpectError sindexOf( x.length, 1.0, {}, 1 ); // $ExpectError - - sindexOf( x.length, 1.0, '1', 1, 1 ); // $ExpectError - sindexOf( x.length, 1.0, true, 1, 1 ); // $ExpectError - sindexOf( x.length, 1.0, false, 1, 1 ); // $ExpectError - sindexOf( x.length, 1.0, null, 1, 1 ); // $ExpectError - sindexOf( x.length, 1.0, {}, 1, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a fourth argument which is not a number... @@ -87,12 +68,6 @@ import sindexOf = require( './index' ); sindexOf( x.length, 2.0, x, false ); // $ExpectError sindexOf( x.length, 2.0, x, null ); // $ExpectError sindexOf( x.length, 2.0, x, {} ); // $ExpectError - - sindexOf( x.length, 2.0, x, '1', 1 ); // $ExpectError - sindexOf( x.length, 2.0, x, true, 1 ); // $ExpectError - sindexOf( x.length, 2.0, x, false, 1 ); // $ExpectError - sindexOf( x.length, 2.0, x, null, 1 ); // $ExpectError - sindexOf( x.length, 2.0, x, {}, 1 ); // $ExpectError } // The compiler throws an error if the function is provided a fifth argument which is not a number... @@ -104,17 +79,79 @@ import sindexOf = require( './index' ); sindexOf( x.length, 2.0, x, 1, false ); // $ExpectError sindexOf( x.length, 2.0, x, 1, null ); // $ExpectError sindexOf( x.length, 2.0, x, 1, {} ); // $ExpectError - - sindexOf( x.length, 2.0, x, 1, '1' ); // $ExpectError - sindexOf( x.length, 2.0, x, 1, true ); // $ExpectError - sindexOf( x.length, 2.0, x, 1, false ); // $ExpectError - sindexOf( x.length, 2.0, x, 1, null ); // $ExpectError - sindexOf( x.length, 2.0, x, 1, {} ); // $ExpectError } // The compiler throws an error if the function is provided an unsupported number of arguments... { sindexOf(); // $ExpectError + sindexOf( 3, 2.0 ); // $ExpectError sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError - sindexOf( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 1, {} ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexOf.ndarray( x.length, 2.0, x, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexOf.ndarray( '1', 2.0, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( true, 2.0, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( false, 2.0, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( null, 2.0, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( {}, 2.0, x, 1, 1 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexOf.ndarray( x.length, '1', x, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, true, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, false, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, null, x, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, {}, x, 1, 1 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a Float32Array... +{ + sindexOf.ndarray( x.length, 1.0, '1', 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 1.0, true, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 1.0, false, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 1.0, null, 1, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 1.0, {}, 1, 1 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexOf.ndarray( x.length, 2.0, x, '1', 1 ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, true, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, false, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, null, 1 ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, {}, 1 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number... +{ + var x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); + + sindexOf.ndarray( x.length, 2.0, x, 1, '1' ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, 1, true ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, 1, false ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, 1, null ); // $ExpectError + sindexOf.ndarray( x.length, 2.0, x, 1, {} ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + sindexOf.ndarray(); // $ExpectError + sindexOf.ndarray( 3, 2.0 ); // $ExpectError + sindexOf.ndarray( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ) ); // $ExpectError + sindexOf.ndarray( 3, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); // $ExpectError } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js index bf32f004b19d..7bb5a94eb079 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/index.js @@ -25,14 +25,6 @@ var x = discreteUniform( 10, -100, 100, { 'dtype': 'float32' }); console.log( x ); -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 ); +var idx = sindexOf( x.length, 80.0, x, 1 ); console.log( idx ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js index 0f5abe026177..1d43474281c2 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/index.js @@ -31,11 +31,27 @@ * * var idx = sindexOf( x.length, 3.0, x, 1 ); * // returns 2 +* +* @example +* var Float32Array = require( '@stdlib/array/float32' ); +* var sindexOf = require( '@stdlib/blas/ext/base/sindex-of' ); +* +* var x = new Float32Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, 3.0 ] ); +* +* var idx = sindexOf.ndarray( x.length, 3.0, x, 1, 0 ); +* // returns 2 */ // MODULES // +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); var main = require( './main.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( main, 'ndarray', ndarray ); // EXPORTS // diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js index 0925cc617f65..cda563bfbc07 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js @@ -18,6 +18,12 @@ 'use strict'; +// MODULES // + +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + // MAIN // /** @@ -27,7 +33,6 @@ * @param {Number} searchElement - number to search index of * @param {Float32Array} x - input array * @param {integer} strideX - index increment -* @param {NonNegativeInteger} [offsetX] - starting index * @returns {integer} index * * @example @@ -38,36 +43,8 @@ * var idx = sindexOf( x.length, 3.0, x, 1 ); * // returns 2 */ -function sindexOf( N, searchElement, x, strideX, offsetX ) { - var ix; - var i; - - if ( N <= 0 || x.length === 0 ) { - return -1; - } - - if ( offsetX === void 0 ) { - if ( strideX < 0 ) { - ix = x.length - 1; - } else { - ix = 0; - } - } else if ( offsetX < 0 ) { - ix = x.length + offsetX; - } else { - ix = offsetX; - } - - for ( i = 0; i < N; i++ ) { - if ( x[ ix ] === searchElement ) { - return ix; - } - ix += strideX; - if ( ix < 0 || ix >= x.length ) { - break; - } - } - return -1; +function sindexOf( N, searchElement, x, strideX ) { + return ndarray( N, searchElement, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js new file mode 100644 index 000000000000..a1ea17a0aa15 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js @@ -0,0 +1,62 @@ +/** +* @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'; + +// MAIN // + +/** +* 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 +* @param {Float32Array} x - input array +* @param {integer} strideX - index increment +* @param {NonNegativeInteger} offsetX - starting index +* @returns {integer} index +* +* @example +* 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, 0 ); +* // returns 2 +*/ +function sindexOf( N, searchElement, x, strideX, offsetX ) { + var ix; + var i; + + if ( N <= 0 || x.length === 0 ) { + return -1; + } + + ix = offsetX; + for ( i = 0; i < N; i++ ) { + if ( x[ ix ] === searchElement ) { + return ix; + } + ix += strideX; + } + return -1; +} + + +// EXPORTS // + +module.exports = sindexOf; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js index 280e879b2ebf..1b4b4d8f8781 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var Float32Array = require( '@stdlib/array/float32' ); var sindexOf = require( './../lib' ); @@ -33,104 +32,7 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function returns the first index of an element which equals a provided search element', function test( t ) { - var actual; - var x; - - x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); - - actual = sindexOf( x.length, 1.0, x, 1 ); - t.strictEqual( actual, 0, 'returns expected value' ); - - actual = sindexOf( x.length, 2.0, x, 1 ); - t.strictEqual( actual, 2, 'returns expected value' ); - - actual = sindexOf( x.length, 3.0, x, 1 ); - t.strictEqual( actual, 4, 'returns expected value' ); - - // Nonnegative offset and stride... - actual = sindexOf( x.length, 1.0, x, 1, 1 ); - t.strictEqual( actual, 1, 'returns expected value' ); - - actual = sindexOf( x.length, 2.0, x, 1, 3 ); - t.strictEqual( actual, 3, 'returns expected value' ); - - actual = sindexOf( x.length, 3.0, x, 1, 5 ); - t.strictEqual( actual, 5, 'returns expected value' ); - - // Negative offset and Nonnegative stride... - actual = sindexOf( x.length, 1.0, x, 1, -6 ); - t.strictEqual( actual, 0, 'returns expected value' ); - - actual = sindexOf( x.length, 3.0, x, 1, -3 ); - t.strictEqual( actual, 4, 'returns expected value' ); - - actual = sindexOf( x.length, 1.0, x, 1, -5 ); - t.strictEqual( actual, 1, 'returns expected value' ); - - actual = sindexOf( x.length, 3.0, x, 1, -1 ); - t.strictEqual( actual, 5, 'returns expected value' ); - - // Negative offset and Negative stride... - actual = sindexOf( x.length, 1.0, x, -1, -1 ); - t.strictEqual( actual, 1, 'returns expected value' ); - - actual = sindexOf( x.length, 3.0, x, -1, -1 ); - t.strictEqual( actual, 5, 'returns expected value' ); - - actual = sindexOf( x.length, 1.0, x, -1, -6 ); - t.strictEqual( actual, 0, 'returns expected value' ); - - actual = sindexOf( x.length, 2.0, x, -1, -2 ); - t.strictEqual( actual, 3, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns `-1` if provided an empty array', function test( t ) { - var actual; - - actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0, 0 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { - var actual; - - actual = sindexOf( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - actual = sindexOf( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns `-1` if provided a search element equal to `NaN`', function test( t ) { - var actual; - - actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1, 1 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns `-1` if provided an offset which exceeds the maximum array index', function test( t ) { - var actual; - var x; - - x = new Float32Array( [ 1.0, 2.0, 3.0 ] ); - - actual = sindexOf( x.length, 2.0, x, 1, 20 ); - t.strictEqual( actual, -1, 'returns expected value' ); - +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof sindexOf.ndarray, 'function', 'method is a function' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js new file mode 100644 index 000000000000..7dbcf74e5981 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.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 tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var sindexOf = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof sindexOf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the first index of an element which equals a provided search element', function test( t ) { + var actual; + var x; + + x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); + + // Nonnegative stride... + actual = sindexOf( x.length, 1.0, x, 1 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexOf( x.length, 2.0, x, 1 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + actual = sindexOf( x.length, 3.0, x, 1 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + // Negative stride... + actual = sindexOf( x.length, 1.0, x, -1 ); + t.strictEqual( actual, 1, 'returns expected value' ); + + actual = sindexOf( x.length, 2.0, x, -1 ); + t.strictEqual( actual, 3, 'returns expected value' ); + + actual = sindexOf( x.length, 3.0, x, -1 ); + t.strictEqual( actual, 5, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided an empty array', function test( t ) { + var actual; + + actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { + var actual; + + actual = sindexOf( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexOf( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided a search element equal to `NaN`', function test( t ) { + var actual; + + actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js new file mode 100644 index 000000000000..8a6350209bea --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js @@ -0,0 +1,102 @@ +/** +* @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 tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var sindexOf = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof sindexOf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the first index of an element which equals a provided search element', function test( t ) { + var actual; + var x; + + x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); + + // Nonnegative stride... + actual = sindexOf( x.length, 1.0, x, 1, 0 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexOf( x.length, 2.0, x, 1, 1 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + actual = sindexOf( x.length, 3.0, x, 1, 2 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + // Negative stride... + 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' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided an empty array', function test( t ) { + var actual; + + actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { + var actual; + + actual = sindexOf( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexOf( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided a search element equal to `NaN`', function test( t ) { + var actual; + + actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +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(); +}); From de8bb720286a60e4b05c15f8f36dcdae63b94a65 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Fri, 13 Jun 2025 17:23:22 +0500 Subject: [PATCH 04/11] chore: apply code review suggestion Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js index a1ea17a0aa15..2136ea5cd8e7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js @@ -21,7 +21,7 @@ // MAIN // /** -* Returns the index of a specified search element in a single-precision floating-point strided array. +* 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 From 39ee4ab6787d57d7d0bc9e0d23ecb3aa98cd3165 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sat, 14 Jun 2025 09:10:59 +0000 Subject: [PATCH 05/11] fix: apply suggestions from code review --- 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: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/sindex-of/README.md | 12 ++++++------ .../sindex-of/benchmark/benchmark.length.js | 4 ++-- .../sindex-of/benchmark/benchmark.ndarray.js | 4 ++-- .../blas/ext/base/sindex-of/docs/repl.txt | 4 ++-- .../blas/ext/base/sindex-of/lib/main.js | 4 ++-- .../blas/ext/base/sindex-of/lib/ndarray.js | 8 ++++---- .../blas/ext/base/sindex-of/test/test.main.js | 6 +++--- .../ext/base/sindex-of/test/test.ndarray.js | 19 +++++-------------- 8 files changed, 26 insertions(+), 35 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md index b795a9c0401d..50173eb986ba 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md @@ -56,11 +56,11 @@ var idx = sindexOf( x.length, 3.0, x, 1 ); The function has the following parameters: - **N**: number of indexed elements. -- **searchElement**: element to search the index of. +- **searchElement**: search element. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **strideX**: index increment. +- **strideX**: stride length. -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`. ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -79,7 +79,7 @@ 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( 4, -1.0, x, 2 ); -// returns 6 +// returns 3 ``` Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. @@ -95,7 +95,7 @@ var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd // Find index... var idx = sindexOf( 3, -6.0, x1, 2 ); -// returns 4 +// returns 2 ``` #### sindexOf.ndarray( N, searchElement, x, strideX, offsetX ) @@ -123,7 +123,7 @@ 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.ndarray( 3, 3.0, x, 1, x.length-3 ); -// returns 7 +// returns 2 ``` diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js index abefd692a869..4487b63c9792 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.length.js @@ -53,7 +53,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = sindexOf( x.length, 2.0, x, 1 ); + out = sindexOf( x.length, len+1, x, 1 ); if ( out !== out ) { b.fail( 'should return an integer' ); } @@ -89,7 +89,7 @@ function main() { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+':dtype=float32,len='+len, f ); + bench( pkg+':len='+len, f ); } } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js index 55751f4b0497..b52e7bea20a8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/benchmark.ndarray.js @@ -53,7 +53,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - out = sindexOf( x.length, 2.0, x, 1, 0 ); + out = sindexOf( x.length, len+1, x, 1, 0 ); if ( out !== out ) { b.fail( 'should return an integer' ); } @@ -89,7 +89,7 @@ function main() { len = pow( 10, i ); f = createBenchmark( len ); - bench( pkg+':dtype=float32,len='+len, f ); + bench( pkg+':len='+len, f ); } } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt index fbbbf22c3100..b1dd3ec0edfa 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/docs/repl.txt @@ -23,7 +23,7 @@ Input array. strideX: integer - Index increment. + Stride length. Returns ------- @@ -57,7 +57,7 @@ Input array. strideX: integer - Index increment. + Stride length. offsetX: integer Starting index. diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js index cda563bfbc07..88513d666b70 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/main.js @@ -30,9 +30,9 @@ var ndarray = require( './ndarray.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 +* @param {number} searchElement - search element * @param {Float32Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @returns {integer} index * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js index a1ea17a0aa15..e814cf266ba8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.js @@ -24,9 +24,9 @@ * 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 +* @param {number} searchElement - search element * @param {Float32Array} x - input array -* @param {integer} strideX - index increment +* @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @returns {integer} index * @@ -42,14 +42,14 @@ function sindexOf( N, searchElement, x, strideX, offsetX ) { var ix; var i; - if ( N <= 0 || x.length === 0 ) { + if ( N <= 0 ) { return -1; } ix = offsetX; for ( i = 0; i < N; i++ ) { if ( x[ ix ] === searchElement ) { - return ix; + return i; } ix += strideX; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js index 7dbcf74e5981..3d159cb37bb0 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js @@ -51,13 +51,13 @@ tape( 'the function returns the first index of an element which equals a provide // Negative stride... actual = sindexOf( x.length, 1.0, x, -1 ); - t.strictEqual( actual, 1, 'returns expected value' ); + t.strictEqual( actual, 4, 'returns expected value' ); actual = sindexOf( x.length, 2.0, x, -1 ); - t.strictEqual( actual, 3, 'returns expected value' ); + t.strictEqual( actual, 2, 'returns expected value' ); actual = sindexOf( x.length, 3.0, x, -1 ); - t.strictEqual( actual, 5, 'returns expected value' ); + t.strictEqual( actual, 0, 'returns expected value' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js index 8a6350209bea..16087ea098ed 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js @@ -44,20 +44,20 @@ tape( 'the function returns the first index of an element which equals a provide t.strictEqual( actual, 0, 'returns expected value' ); actual = sindexOf( x.length, 2.0, x, 1, 1 ); - t.strictEqual( actual, 2, 'returns expected value' ); + t.strictEqual( actual, 1, 'returns expected value' ); actual = sindexOf( x.length, 3.0, x, 1, 2 ); - t.strictEqual( actual, 4, 'returns expected value' ); + t.strictEqual( actual, 2, 'returns expected value' ); // Negative stride... actual = sindexOf( x.length, 1.0, x, -1, x.length-1 ); - t.strictEqual( actual, 1, 'returns expected value' ); + t.strictEqual( actual, 4, 'returns expected value' ); actual = sindexOf( x.length, 2.0, x, -2, x.length-1 ); - t.strictEqual( actual, 3, 'returns expected value' ); + t.strictEqual( actual, 1, 'returns expected value' ); actual = sindexOf( x.length, 1.0, x, -2, x.length-2 ); - t.strictEqual( actual, 0, 'returns expected value' ); + t.strictEqual( actual, 2, 'returns expected value' ); t.end(); }); @@ -91,12 +91,3 @@ tape( 'the function returns `-1` if provided a search element equal to `NaN`', f t.end(); }); - -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(); -}); From 9248df225017caf69d71c7854867b4149285b240 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sat, 14 Jun 2025 10:53:06 +0000 Subject: [PATCH 06/11] feat: add c apis --- 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: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/blas/ext/base/sindex-of/README.md | 119 +++++++++++ .../ext/base/sindex-of/benchmark/c/Makefile | 146 +++++++++++++ .../sindex-of/benchmark/c/benchmark.length.c | 191 ++++++++++++++++++ .../blas/ext/base/sindex-of/binding.gyp | 170 ++++++++++++++++ .../ext/base/sindex-of/examples/c/Makefile | 146 +++++++++++++ .../ext/base/sindex-of/examples/c/example.c | 37 ++++ .../blas/ext/base/sindex-of/include.gypi | 53 +++++ .../include/stdlib/blas/ext/base/sindexof.h | 45 +++++ .../blas/ext/base/sindex-of/lib/index.js | 17 +- .../blas/ext/base/sindex-of/lib/main.js | 40 ++-- .../blas/ext/base/sindex-of/lib/native.js | 35 ++++ .../ext/base/sindex-of/lib/ndarray.native.js | 53 +++++ .../blas/ext/base/sindex-of/lib/sindexof.js | 53 +++++ .../ext/base/sindex-of/lib/sindexof.native.js | 52 +++++ .../blas/ext/base/sindex-of/manifest.json | 80 ++++++++ .../blas/ext/base/sindex-of/package.json | 20 +- .../blas/ext/base/sindex-of/src/Makefile | 70 +++++++ .../blas/ext/base/sindex-of/src/addon.c | 63 ++++++ .../blas/ext/base/sindex-of/src/main.c | 63 ++++++ .../blas/ext/base/sindex-of/test/test.js | 44 ++++ .../ext/base/sindex-of/test/test.ndarray.js | 13 +- .../sindex-of/test/test.ndarray.native.js | 93 +++++++++ .../test/{test.main.js => test.sindexof.js} | 14 +- .../sindex-of/test/test.sindexof.native.js | 93 +++++++++ 24 files changed, 1654 insertions(+), 56 deletions(-) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/binding.gyp create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/include.gypi create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/include/stdlib/blas/ext/base/sindexof.h create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/sindexof.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/lib/sindexof.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/src/addon.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/src/main.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.native.js rename lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/{test.main.js => test.sindexof.js} (86%) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.native.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md index 50173eb986ba..cb280ceaf57f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md @@ -167,6 +167,125 @@ console.log( idx ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/sindexOf.h" +``` + +#### stdlib_strided_sindexOf( N, searchElement, \*X, strideX ) + +Returns the index of a specified search element in a single-precision floating-point strided array. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +int idx = stdlib_strided_sindexOf( 4, 3.0f, x, 1 ); +// returns 2 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **searchElement**: `[in] float` search element. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. + +```c +CBLAS_INT N stdlib_strided_sindexOf( const CBLAS_INT N, const float searchElement, float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_sindexOf_ndarray( N, searchElement, \*X, strideX, offsetX ) + +Returns the index of a specified search element in a single-precision floating-point strided array using alternative indexing semantics. + +```c +float x[] = { 1.0f, 2.0f, 3.0f, 4.0f }; + +int idx = stdlib_strided_sindexOf( 4, 3.0f, x, 1, 0 ); +// returns 2 +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **searchElement**: `[in] float` search element. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length. +- **offsetX**: `[in] CBLAS_INT` starting index. + +```c +CBLAS_INT stdlib_strided_sindexOf_ndarray( const CBLAS_INT N, const float searchElement, float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/sindexOf.h" +#include + +int main( void ) { + // Create a strided array: + float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; + + // Specify the number of indexed elements: + const int N = 8; + + // Specify a stride: + const int strideX = 1; + + // Fill the array: + int idx = stdlib_strided_sindexOf( N, 5.0f, x, strideX ); + + // Print the result: + printf( "index value: %d\n", idx ); +} +``` + +
+ + + +
+ + +
diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..bb3123bf4b6c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c @@ -0,0 +1,191 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/sindexof.h" +#include +#include +#include +#include +#include + +#define NAME "sindexof" +#define ITERATIONS 10000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static float rand_float( void ) { + int r = rand(); + return (float)r / ( (float)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + float x[ len ]; + double t; + int idx; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_float()*20000.0f ) - 10000.0f; + } + idx = -1; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + idx = stdlib_strided_sindexOf( len, 1000.0f, x, 1 ); + if ( idx < -2 ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( idx < -2 ) { + printf( "unexpected result\n" ); + } + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + float x[ len ]; + double t; + int idx; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_float()*20000.0f ) - 10000.0f; + } + idx = -1; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + idx = stdlib_strided_sindexOf_ndarray( len, 1000.0f, x, 1, 0 ); + if ( idx < -2 ) { + printf( "unexpected result\n" ); + break; + } + } + elapsed = tic() - t; + if ( idx < -2 ) { + printf( "unexpected result\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/binding.gyp b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/binding.gyp new file mode 100644 index 000000000000..68a1ca11d160 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/binding.gyp @@ -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. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/Makefile new file mode 100644 index 000000000000..25ced822f96a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c new file mode 100644 index 000000000000..2500ef28c2c4 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c @@ -0,0 +1,37 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/sindexof.h" +#include + +int main( void ) { + // Create a strided array: + float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; + + // Specify the number of indexed elements: + const int N = 8; + + // Specify a stride: + const int strideX = 1; + + // Fill the array: + int idx = stdlib_strided_sindexOf( N, 5.0f, x, strideX ); + + // Print the result: + printf( "index value: %d\n", idx ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include.gypi new file mode 100644 index 000000000000..ecfaf82a3279 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include.gypi @@ -0,0 +1,53 @@ +# @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. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, searchElement, argv, 1 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_CREATE_INT32( env, API_SUFFIX(stdlib_strided_sindexOf)( N, searchElement, X, strideX ), idx ); // TODO: Need to revisit in order to support int64_t for CBLAS_INT + return idx; +} + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, searchElement, argv, 1 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 4 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 2 ); + STDLIB_NAPI_CREATE_INT32( env, API_SUFFIX(stdlib_strided_sindexOf_ndarray)( N, searchElement, X, strideX, offsetX ), idx ); // TODO: Need to revisit in order to support int64_t for CBLAS_INT + return idx; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/src/main.c new file mode 100644 index 000000000000..cc2a5924afd8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/src/main.c @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/sindexof.h" +#include "stdlib/strided/base/stride2offset.h" +#include "stdlib/blas/base/shared.h" + +/** +* Returns the index of a specified search element in a single-precision floating-point strided array. +* +* @param N number of indexed elements +* @param searchElement search element +* @param X input array +* @param strideX stride length +* @return index +*/ +CBLAS_INT API_SUFFIX(stdlib_strided_sindexOf)( const CBLAS_INT N, const CBLAS_INT searchElement, const float *X, const CBLAS_INT strideX ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_sindexOf_ndarray)( N, searchElement, X, strideX, ox ); +} + +/** +* Returns the index of a specified search element in a single-precision floating-point strided array using alternative indexing semantics. +* +* @param N number of indexed elements +* @param searchElement search element +* @param X input array +* @param strideX stride length +* @param offsetX starting index +* @return index +*/ +CBLAS_INT API_SUFFIX(stdlib_strided_sindexOf_ndarray)( const CBLAS_INT N, const CBLAS_INT searchElement, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; + + if ( N <= 0 ) { + return -1; + } + + ix = offsetX; + for ( i = 0; i < N; i++ ) { + if ( X[ ix ] == searchElement ) { + return i; + } + ix += strideX; + } + return -1; +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js index 1b4b4d8f8781..fde9c8b5ea39 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.js @@ -21,9 +21,18 @@ // MODULES // var tape = require( 'tape' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); var sindexOf = require( './../lib' ); +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + // TESTS // tape( 'main export is a function', function test( t ) { @@ -36,3 +45,38 @@ tape( 'attached to the main export is a method providing an ndarray interface', t.strictEqual( typeof sindexOf.ndarray, 'function', 'method is a function' ); t.end(); }); + +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var sindexOf = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( sindexOf, mock, 'returns expected value' ); + t.end(); + + function tryRequire() { + return mock; + } + + function mock() { + // Mock... + } +}); + +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var sindexOf; + var main; + + main = require( './../lib/sindexof.js' ); + + sindexOf = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( sindexOf, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js index 16087ea098ed..a28d6bfa73d7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.js @@ -53,24 +53,15 @@ tape( 'the function returns the first index of an element which equals a provide actual = sindexOf( x.length, 1.0, x, -1, x.length-1 ); t.strictEqual( actual, 4, 'returns expected value' ); - actual = sindexOf( x.length, 2.0, x, -2, x.length-1 ); + actual = sindexOf( 3, 2.0, x, -2, x.length-1 ); t.strictEqual( actual, 1, 'returns expected value' ); - actual = sindexOf( x.length, 1.0, x, -2, x.length-2 ); + actual = sindexOf( 3, 1.0, x, -2, x.length-2 ); t.strictEqual( actual, 2, 'returns expected value' ); t.end(); }); -tape( 'the function returns `-1` if provided an empty array', function test( t ) { - var actual; - - actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0, 0 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - t.end(); -}); - tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { var actual; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.native.js new file mode 100644 index 000000000000..6fa978175f17 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.ndarray.native.js @@ -0,0 +1,93 @@ +/** +* @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 resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var sindexOf = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( sindexOf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof sindexOf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the first index of an element which equals a provided search element', opts, function test( t ) { + var actual; + var x; + + x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); + + // Nonnegative stride... + actual = sindexOf( x.length, 1.0, x, 1, 0 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexOf( x.length, 2.0, x, 1, 1 ); + t.strictEqual( actual, 1, 'returns expected value' ); + + actual = sindexOf( x.length, 3.0, x, 1, 2 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + // Negative stride... + actual = sindexOf( x.length, 1.0, x, -1, x.length-1 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + actual = sindexOf( 3, 2.0, x, -2, x.length-1 ); + t.strictEqual( actual, 1, 'returns expected value' ); + + actual = sindexOf( 3, 1.0, x, -2, x.length-2 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', opts, function test( t ) { + var actual; + + actual = sindexOf( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexOf( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided a search element equal to `NaN`', opts, function test( t ) { + var actual; + + actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1, 0 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.js similarity index 86% rename from lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js rename to lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.js index 3d159cb37bb0..2bd5fa19f2c9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.main.js +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.js @@ -22,7 +22,7 @@ var tape = require( 'tape' ); var Float32Array = require( '@stdlib/array/float32' ); -var sindexOf = require( './../lib' ); +var sindexOf = require( './../lib/sindexof.js' ); // TESTS // @@ -62,18 +62,6 @@ tape( 'the function returns the first index of an element which equals a provide t.end(); }); -tape( 'the function returns `-1` if provided an empty array', function test( t ) { - var actual; - - actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - actual = sindexOf( 1, 0.0, new Float32Array( [] ), 0, 0 ); - t.strictEqual( actual, -1, 'returns expected value' ); - - t.end(); -}); - tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', function test( t ) { var actual; diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.native.js b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.native.js new file mode 100644 index 000000000000..90f6fb4d7479 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/test/test.sindexof.native.js @@ -0,0 +1,93 @@ +/** +* @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 resolve = require( 'path' ).resolve; +var tape = require( 'tape' ); +var Float32Array = require( '@stdlib/array/float32' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var sindexOf = tryRequire( resolve( __dirname, './../lib/sindexof.native.js' ) ); +var opts = { + 'skip': ( sindexOf instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof sindexOf, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the first index of an element which equals a provided search element', opts, function test( t ) { + var actual; + var x; + + x = new Float32Array( [ 1.0, 1.0, 2.0, 2.0, 3.0, 3.0 ] ); + + // Nonnegative stride... + actual = sindexOf( x.length, 1.0, x, 1 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + actual = sindexOf( x.length, 2.0, x, 1 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + actual = sindexOf( x.length, 3.0, x, 1 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + // Negative stride... + actual = sindexOf( x.length, 1.0, x, -1 ); + t.strictEqual( actual, 4, 'returns expected value' ); + + actual = sindexOf( x.length, 2.0, x, -1 ); + t.strictEqual( actual, 2, 'returns expected value' ); + + actual = sindexOf( x.length, 3.0, x, -1 ); + t.strictEqual( actual, 0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided `N` parameter is less than or equal to zero', opts, function test( t ) { + var actual; + + actual = sindexOf( 0, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + actual = sindexOf( -1, 2.0, new Float32Array( [ 1.0, 2.0, 3.0 ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `-1` if provided a search element equal to `NaN`', opts, function test( t ) { + var actual; + + actual = sindexOf( 1, NaN, new Float32Array( [ NaN ] ), 1 ); + t.strictEqual( actual, -1, 'returns expected value' ); + + t.end(); +}); From fc5026573294f6d2295faa15972fa4cc4d70c4fe Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sat, 14 Jun 2025 21:40:59 +0500 Subject: [PATCH 07/11] chore: apply suggestions from code review Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md | 4 ++-- .../@stdlib/blas/ext/base/sindex-of/examples/c/example.c | 2 +- .../base/sindex-of/include/stdlib/blas/ext/base/sindexof.h | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md index cb280ceaf57f..41820d5ab365 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/README.md @@ -190,7 +190,7 @@ console.log( idx ); ### Usage ```c -#include "stdlib/blas/ext/base/sindexOf.h" +#include "stdlib/blas/ext/base/sindexof.h" ``` #### stdlib_strided_sindexOf( N, searchElement, \*X, strideX ) @@ -257,7 +257,7 @@ CBLAS_INT stdlib_strided_sindexOf_ndarray( const CBLAS_INT N, const float search ### Examples ```c -#include "stdlib/blas/ext/base/sindexOf.h" +#include "stdlib/blas/ext/base/sindexof.h" #include int main( void ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c index 2500ef28c2c4..33e38d68f72f 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c @@ -29,7 +29,7 @@ int main( void ) { // Specify a stride: const int strideX = 1; - // Fill the array: + // Search the index: int idx = stdlib_strided_sindexOf( N, 5.0f, x, strideX ); // Print the result: diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include/stdlib/blas/ext/base/sindexof.h b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include/stdlib/blas/ext/base/sindexof.h index 587fa4d1db54..7be0ad31f1e3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include/stdlib/blas/ext/base/sindexof.h +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/include/stdlib/blas/ext/base/sindexof.h @@ -16,8 +16,8 @@ * limitations under the License. */ -#ifndef STDLIB_BLAS_EXT_BASE_SNANSUMKBN_H -#define STDLIB_BLAS_EXT_BASE_SNANSUMKBN_H +#ifndef STDLIB_BLAS_EXT_BASE_SINDEXOF_H +#define STDLIB_BLAS_EXT_BASE_SINDEXOF_H #include "stdlib/blas/base/shared.h" From d9a62a7bb3e5651a5f000ccd1588a3ab14ef1550 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sat, 14 Jun 2025 21:52:19 +0500 Subject: [PATCH 08/11] fix: lint error Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- .../@stdlib/blas/ext/base/sindex-of/examples/c/example.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c index 33e38d68f72f..27923fcab652 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/examples/c/example.c @@ -21,7 +21,7 @@ int main( void ) { // Create a strided array: - float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; + const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f }; // Specify the number of indexed elements: const int N = 8; From 69178aa2635535b920ba4350973e21395b8e4012 Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sat, 14 Jun 2025 22:07:35 +0500 Subject: [PATCH 09/11] chore: ignore uninitvar Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- .../blas/ext/base/sindex-of/benchmark/c/benchmark.length.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c index bb3123bf4b6c..4584c268c25a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c @@ -107,6 +107,7 @@ static double benchmark1( int iterations, int len ) { idx = -1; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar idx = stdlib_strided_sindexOf( len, 1000.0f, x, 1 ); if ( idx < -2 ) { printf( "unexpected result\n" ); @@ -140,6 +141,7 @@ static double benchmark2( int iterations, int len ) { idx = -1; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar idx = stdlib_strided_sindexOf_ndarray( len, 1000.0f, x, 1, 0 ); if ( idx < -2 ) { printf( "unexpected result\n" ); From 8174a0c557e26230cf5803a7977e5cc4022d19ca Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sun, 15 Jun 2025 09:06:52 +0000 Subject: [PATCH 10/11] refactor: c benchmark --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../blas/ext/base/sindex-of/benchmark/c/benchmark.length.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c index bb3123bf4b6c..3432e10dec02 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c @@ -107,7 +107,7 @@ static double benchmark1( int iterations, int len ) { idx = -1; t = tic(); for ( i = 0; i < iterations; i++ ) { - idx = stdlib_strided_sindexOf( len, 1000.0f, x, 1 ); + idx = stdlib_strided_sindexOf( len, 20000.0f, x, 1 ); if ( idx < -2 ) { printf( "unexpected result\n" ); break; @@ -140,7 +140,7 @@ static double benchmark2( int iterations, int len ) { idx = -1; t = tic(); for ( i = 0; i < iterations; i++ ) { - idx = stdlib_strided_sindexOf_ndarray( len, 1000.0f, x, 1, 0 ); + idx = stdlib_strided_sindexOf_ndarray( len, 20000.0f, x, 1, 0 ); if ( idx < -2 ) { printf( "unexpected result\n" ); break; From 2fdaf8b19aad9ff25612f7f3c9a63cd40c1f305d Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sun, 15 Jun 2025 09:34:57 +0000 Subject: [PATCH 11/11] chore: lint error --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../blas/ext/base/sindex-of/benchmark/c/benchmark.length.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c index 3432e10dec02..1f9ec0b027b4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/sindex-of/benchmark/c/benchmark.length.c @@ -107,6 +107,7 @@ static double benchmark1( int iterations, int len ) { idx = -1; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar idx = stdlib_strided_sindexOf( len, 20000.0f, x, 1 ); if ( idx < -2 ) { printf( "unexpected result\n" ); @@ -140,6 +141,7 @@ static double benchmark2( int iterations, int len ) { idx = -1; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar idx = stdlib_strided_sindexOf_ndarray( len, 20000.0f, x, 1, 0 ); if ( idx < -2 ) { printf( "unexpected result\n" );