diff --git a/lib/node_modules/@stdlib/blas/base/icamax/README.md b/lib/node_modules/@stdlib/blas/base/icamax/README.md new file mode 100644 index 000000000000..96326bff2677 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/README.md @@ -0,0 +1,172 @@ + + +# icamax + +> Find the index of the first element having maximum |Re(.)| + |Im(.)|. + +
+ +## Usage + +```javascript +var icamax = require( '@stdlib/blas/base/icamax' ); +``` + +#### icamax( N, x, strideX ) + +Finds the index of the first element having maximum |Re(.)| + |Im(.)|. + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); + +var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); + +var idx = icamax( x.length, x, 1 ); +// returns 1 +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Complex64Array`][@stdlib/array/complex64]. +- **strideX**: index increment for `x`. + +The `N` and `strideX` parameters determine which elements in `x` are accessed at runtime. For example, to traverse every other value, + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); + +var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); + +var idx = icamax( 2, x, 2 ); +// returns 1 +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); + +// Initial array: +var x0 = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); + +// Create an offset view: +var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +// Find index of element having the maximum |Re(.)| + |Im(.)|: +var idx = icamax( 2, x1, 1 ); +// returns 1 +``` + +#### icamax.ndarray( N, x, strideX, offsetX ) + +Finds the index of the first element having maximum |Re(.)| + |Im(.)| using alternative indexing semantics. + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); + +var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); + +var idx = icamax.ndarray( x.length, x, 1, 0 ); +// 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 start from the second index, + +```javascript +var Complex64Array = require( '@stdlib/array/complex64' ); + +var x = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 ] ); + +var idx = icamax.ndarray( 3, x, 1, 1 ); +// returns 2 +``` + +
+ + + +
+ +## Notes + +- If `N < 1`, both functions return `-1`. +- `icamax()` corresponds to the [BLAS][blas] level 1 function [`icamax`][icamax]. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var complex64 = require( '@stdlib/complex/float32/ctor' ); +var icamax = require( '@stdlib/blas/base/icamax' ); + +function rand() { + return new complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +// Generate random input arrays: +var x = filledarrayBy( 10, 'complex64', rand ); +console.log( x.toString() ); + +var idx = icamax( x.length, x, 1 ); +console.log( idx ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[blas]: http://www.netlib.org/blas + +[icamax]: https://www.netlib.org/lapack/explore-html/dd/d52/group__iamax_gafdf273dcc3f020e2aa5c716c1b3d7265.html + +[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64 + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray + +
+ + diff --git a/lib/node_modules/@stdlib/blas/base/icamax/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/icamax/benchmark/benchmark.js new file mode 100644 index 000000000000..4017200256ec --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/benchmark/benchmark.js @@ -0,0 +1,104 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var pkg = require( './../package.json' ).name; +var icamax = require( './../lib/icamax.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var idx; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + idx = icamax( x.length, x, 1 ); + if ( isnanf( idx ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( idx ) ) { + b.fail( 'should not return NaN' ); + } + 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+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/icamax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/icamax/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..f78028194a7e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/benchmark/benchmark.ndarray.js @@ -0,0 +1,104 @@ +/** +* @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 uniform = require( '@stdlib/random/array/uniform' ); +var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Complex64Array = require( '@stdlib/array/complex64' ); +var pkg = require( './../package.json' ).name; +var icamax = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = new Complex64Array( uniform( len*2, -100.0, 100.0, options ) ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var idx; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + idx = icamax( x.length, x, 1, 0 ); + if ( isnanf( idx ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnanf( idx ) ) { + b.fail( 'should not return NaN' ); + } + 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+':ndarray:len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/icamax/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/icamax/docs/repl.txt new file mode 100644 index 000000000000..22e50e7da7bc --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/docs/repl.txt @@ -0,0 +1,89 @@ + +{{alias}}( N, x, strideX ) + Finds the index of the first element having maximum |Re(.)| + |Im(.)|. + + The `N` and `strideX` parameters determine which elements in `x` are + accessed at runtime. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `N < 1`, the function returns `-1`. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex64Array + Input array. + + strideX: integer + Index increment for `x`. + + Returns + ------- + idx: integer + Index value. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/complex64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] ); + > var idx = {{alias}}( x.length, x, 1 ) + 1 + + // Using `N` and `strideX` parameters: + > x = new {{alias:@stdlib/array/complex64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] ); + > idx = {{alias}}( 2, x, 2 ) + 1 + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/complex64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); + > var x1 = new {{alias:@stdlib/array/complex64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > idx = {{alias}}( 2, x1, 1 ) + 1 + + +{{alias}}.ndarray( N, x, strideX, offsetX ) + Finds the index of the first element having maximum |Re(.)| + |Im(.)| using + alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the `offsetX` parameter supports indexing semantics based on a + starting index. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Complex64Array + Input array. + + strideX: integer + Index increment for `x`. + + offsetX: integer + Starting index of `x`. + + Returns + ------- + idx: integer + Index value. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/complex64}}( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0 ] ); + > var idx = {{alias}}.ndarray( x.length, x, 1, 0 ) + 1 + + // Using an index offset: + > x = new {{alias:@stdlib/array/complex64}}( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] ); + > idx = {{alias}}.ndarray( 2, x, 1, 1 ) + 1 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/icamax/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/icamax/docs/types/index.d.ts new file mode 100644 index 000000000000..df8d0704a839 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/docs/types/index.d.ts @@ -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. +*/ + +// TypeScript Version: 4.1 + +/// + +import { Complex64Array } from '@stdlib/types/array'; + +/** +* Interface describing `icamax`. +*/ +interface Routine { + /** + * Finds the index of the first element having maximum |Re(.)| + |Im(.)|. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length for `x` + * @returns index value + * + * @example + * var Complex64Array = require( '@stdlib/array/complex64' ); + * + * var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); + * + * var idx = icamax( x.length, x, 1 ); + * // returns 1 + */ + ( N: number, x: Complex64Array, strideX: number ): number; + + /** + * Finds the index of the first element having maximum |Re(.)| + |Im(.)| using alternative indexing semantics. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length for `x` + * @param offset - starting index for `x` + * @returns index value + * + * @example + * var Complex64Array = require( '@stdlib/array/complex64' ); + * + * var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); + * + * var idx = icamax.ndarray( x.length, x, 1, 0 ); + * // returns 1 + */ + ndarray( N: number, x: Complex64Array, strideX: number, offset: number ): number; +} + +/** +* Finds the index of the first element having maximum |Re(.)| + |Im(.)| +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - stride length for `x` +* @returns index value +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* +* var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); +* +* var idx = icamax( x.length, x, 1 ); +* // returns 1 +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* +* var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); +* +* var idx = icamax.ndarray( x.length, x, 1, 0 ); +* // returns 1 +*/ +declare var icamax: Routine; + + +// EXPORTS // + +export = icamax; diff --git a/lib/node_modules/@stdlib/blas/base/icamax/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/icamax/docs/types/test.ts new file mode 100644 index 000000000000..a10158751a93 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/docs/types/test.ts @@ -0,0 +1,158 @@ +/* +* @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 Complex64Array = require( '@stdlib/array/complex64' ); +import icamax = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = new Complex64Array( 10 ); + + icamax( x.length, x, 1 ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Complex64Array( 10 ); + + icamax( '10', x, 1 ); // $ExpectError + icamax( true, x, 1 ); // $ExpectError + icamax( false, x, 1 ); // $ExpectError + icamax( null, x, 1 ); // $ExpectError + icamax( undefined, x, 1 ); // $ExpectError + icamax( [], x, 1 ); // $ExpectError + icamax( {}, x, 1 ); // $ExpectError + icamax( ( x: number ): number => x, x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + + icamax( x.length, 10, 1 ); // $ExpectError + icamax( x.length, '10', 1 ); // $ExpectError + icamax( x.length, true, 1 ); // $ExpectError + icamax( x.length, false, 1 ); // $ExpectError + icamax( x.length, null, 1 ); // $ExpectError + icamax( x.length, undefined, 1 ); // $ExpectError + icamax( x.length, [], 1 ); // $ExpectError + icamax( x.length, {}, 1 ); // $ExpectError + icamax( x.length, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Complex64Array( 10 ); + + icamax( x.length, x, '10' ); // $ExpectError + icamax( x.length, x, true ); // $ExpectError + icamax( x.length, x, false ); // $ExpectError + icamax( x.length, x, null ); // $ExpectError + icamax( x.length, x, undefined ); // $ExpectError + icamax( x.length, x, [] ); // $ExpectError + icamax( x.length, x, {} ); // $ExpectError + icamax( x.length, x, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Complex64Array( 10 ); + + icamax(); // $ExpectError + icamax( x.length ); // $ExpectError + icamax( x.length, x ); // $ExpectError + icamax( x.length, x, 1, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a number... +{ + const x = new Complex64Array( 10 ); + + icamax.ndarray( x.length, x, 1, 0 ); // $ExpectType number +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Complex64Array( 10 ); + + icamax.ndarray( '10', x, 1, 0 ); // $ExpectError + icamax.ndarray( true, x, 1, 0 ); // $ExpectError + icamax.ndarray( false, x, 1, 0 ); // $ExpectError + icamax.ndarray( null, x, 1, 0 ); // $ExpectError + icamax.ndarray( undefined, x, 1, 0 ); // $ExpectError + icamax.ndarray( [], x, 1, 0 ); // $ExpectError + icamax.ndarray( {}, x, 1, 0 ); // $ExpectError + icamax.ndarray( ( x: number ): number => x, x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Complex64Array... +{ + const x = new Complex64Array( 10 ); + + icamax.ndarray( x.length, 10, 1, 0 ); // $ExpectError + icamax.ndarray( x.length, '10', 1, 0 ); // $ExpectError + icamax.ndarray( x.length, true, 1, 0 ); // $ExpectError + icamax.ndarray( x.length, false, 1, 0 ); // $ExpectError + icamax.ndarray( x.length, null, 1, 0 ); // $ExpectError + icamax.ndarray( x.length, undefined, 1, 0 ); // $ExpectError + icamax.ndarray( x.length, [], 1, 0 ); // $ExpectError + icamax.ndarray( x.length, {}, 1, 0 ); // $ExpectError + icamax.ndarray( x.length, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Complex64Array( 10 ); + + icamax.ndarray( x.length, x, '10', 0 ); // $ExpectError + icamax.ndarray( x.length, x, true, 0 ); // $ExpectError + icamax.ndarray( x.length, x, false, 0 ); // $ExpectError + icamax.ndarray( x.length, x, null, 0 ); // $ExpectError + icamax.ndarray( x.length, x, undefined, 0 ); // $ExpectError + icamax.ndarray( x.length, x, [], 0 ); // $ExpectError + icamax.ndarray( x.length, x, {}, 0 ); // $ExpectError + icamax.ndarray( x.length, x, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Complex64Array( 10 ); + + icamax.ndarray( x.length, x, 1, '10' ); // $ExpectError + icamax.ndarray( x.length, x, 1, true ); // $ExpectError + icamax.ndarray( x.length, x, 1, false ); // $ExpectError + icamax.ndarray( x.length, x, 1, null ); // $ExpectError + icamax.ndarray( x.length, x, 1, undefined ); // $ExpectError + icamax.ndarray( x.length, x, 1, [] ); // $ExpectError + icamax.ndarray( x.length, x, 1, {} ); // $ExpectError + icamax.ndarray( x.length, x, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Complex64Array( 10 ); + + icamax.ndarray(); // $ExpectError + icamax.ndarray( x.length ); // $ExpectError + icamax.ndarray( x.length, x ); // $ExpectError + icamax.ndarray( x.length, x, 1 ); // $ExpectError + icamax.ndarray( x.length, x, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/icamax/examples/index.js b/lib/node_modules/@stdlib/blas/base/icamax/examples/index.js new file mode 100644 index 000000000000..016dec014ed0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/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/base/discrete-uniform' ); +var filledarrayBy = require( '@stdlib/array/filled-by' ); +var Complex64 = require( '@stdlib/complex/float32/ctor' ); +var icamax = require( './../lib' ); + +function rand() { + return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) ); +} + +// Generate random input array: +var x = filledarrayBy( 10, 'complex64', rand ); +console.log( x.toString() ); + +var idx = icamax( x.length, x, 1 ); +console.log( idx ); + +idx = icamax.ndarray( x.length, x, 1, 0 ); +console.log( idx ); diff --git a/lib/node_modules/@stdlib/blas/base/icamax/lib/icamax.js b/lib/node_modules/@stdlib/blas/base/icamax/lib/icamax.js new file mode 100644 index 000000000000..ed583413280a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/lib/icamax.js @@ -0,0 +1,52 @@ +/** +* @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 stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +/** +* Finds the index of the first element having maximum |Re(.)| + |Im(.)|. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - `x` stride length +* @returns {integer} index value +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* +* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); +* +* var idx = icamax( x.length, x, 1 ); +* // returns 3 +*/ +function icamax( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); +} + + +// EXPORTS // + +module.exports = icamax; diff --git a/lib/node_modules/@stdlib/blas/base/icamax/lib/index.js b/lib/node_modules/@stdlib/blas/base/icamax/lib/index.js new file mode 100644 index 000000000000..35a480e590cb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/lib/index.js @@ -0,0 +1,68 @@ +/** +* @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'; + +/** +* BLAS level 1 routine to find the index of the first element having maximum |Re(.)| + |Im(.)|. +* +* @module @stdlib/blas/base/icamax +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var icamax = require( '@stdlib/blas/base/icamax' ); +* +* var x = new Float64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); +* +* var idx = icamax( x.length, x, 1 ); +* // returns 1 +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* var icamax = require( '@stdlib/blas/base/icamax' ); +* +* var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); +* +* var idx = icamax.ndarray( x.length, x, 1, 0 ); +* // returns 1 +*/ + +// MODULES // + +var join = require( 'path' ).join; +var tryRequire = require( '@stdlib/utils/try-require' ); +var isError = require( '@stdlib/assert/is-error' ); +var main = require( './main.js' ); + + +// MAIN // + +var icamax; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + icamax = main; +} else { + icamax = tmp; +} + + +// EXPORTS // + +module.exports = icamax; + +// exports: { "ndarray": "icamax.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/base/icamax/lib/main.js b/lib/node_modules/@stdlib/blas/base/icamax/lib/main.js new file mode 100644 index 000000000000..d2170a733e24 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/lib/main.js @@ -0,0 +1,35 @@ +/** +* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var icamax = require( './icamax.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( icamax, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = icamax; diff --git a/lib/node_modules/@stdlib/blas/base/icamax/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/icamax/lib/ndarray.js new file mode 100644 index 000000000000..347e0bfbf895 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/lib/ndarray.js @@ -0,0 +1,73 @@ +/** +* @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 scabs1 = require( '@stdlib/blas/base/scabs1' ); + + +// MAIN // + +/** +* Finds the index of the first element having maximum |Re(.)| + |Im(.)|. +* +* @param {PositiveInteger} N - number of indexed elements +* @param {Complex64Array} x - input array +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @returns {integer} index value +* +* @example +* var Complex64Array = require( '@stdlib/array/complex64' ); +* +* var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] ); +* +* var idx = icamax( x.length, x, 1, 0 ); +* // returns 1 +*/ +function icamax( N, x, strideX, offsetX ) { + var max; + var idx; + var ix; + var i; + + if ( N < 1 ) { + return -1; + } + idx = 0; + if ( N === 1 ) { + return idx; + } + max = scabs1( x.get( offsetX ) ); + ix = offsetX + strideX; + for ( i = 1; i < N; i++ ) { + if ( scabs1( x.get( ix ) ) > max ) { + idx = i; + max = scabs1( x.get( ix ) ); + } + ix += strideX; + } + return idx; +} + + +// EXPORTS // + +module.exports = icamax; diff --git a/lib/node_modules/@stdlib/blas/base/icamax/package.json b/lib/node_modules/@stdlib/blas/base/icamax/package.json new file mode 100644 index 000000000000..d029d6d6c3fe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/package.json @@ -0,0 +1,75 @@ +{ + "name": "@stdlib/blas/base/icamax", + "version": "0.0.0", + "description": "Find the index of the first element having maximum |Re(.)| + |Im(.)|", + "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", + "stdmath", + "mathematics", + "math", + "blas", + "level 1", + "icamax", + "maximum", + "scabs1", + "absolute", + "find", + "index", + "linear", + "algebra", + "subroutines", + "vector", + "array", + "ndarray", + "complex", + "complex64", + "complex64array" + ] +} + diff --git a/lib/node_modules/@stdlib/blas/base/icamax/test/test.icamax.js b/lib/node_modules/@stdlib/blas/base/icamax/test/test.icamax.js new file mode 100644 index 000000000000..93cdc7529be7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/test/test.icamax.js @@ -0,0 +1,182 @@ +/** +* @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 Complex64Array = require( '@stdlib/array/complex64' ); +var icamax = require( './../lib/icamax.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof icamax, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 3', function test( t ) { + t.strictEqual( icamax.length, 3, 'returns expected value' ); + t.end(); +}); + +tape( 'the function finds the index of the element with the maximum |Re(.)| + |Im(.)|', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 0.1, // 0 + -0.3, // 0 + 0.5, // 1 + -0.1, // 1 + -0.2, // 2 + 0.6, // 2 + -0.4, // 3 + 0.9 // 3 + ]); + expected = 3; + + idx = icamax( 4, x, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + x = new Complex64Array([ + 0.2, // 0 + -0.6, // 0 + 0.3, // 1 + 0.6, // 1 + 5.0, + 5.0 + ]); + expected = 1; + + idx = icamax( 2, x, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than `1`, the function returns `-1`', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 1.0, + 2.0, + 3.0, + 4.0 + ]); + expected = -1; + + idx = icamax( 0, x, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns `0`', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 1.0, + 2.0, + 3.0, + 4.0 + ]); + expected = 0; + + idx = icamax( 1, x, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 0.1, // 0 + 4.0, // 0 + -0.3, + 6.0, + -0.5, // 1 + 7.0, // 1 + -0.1, + 3.0 + ]); + expected = 1; + + idx = icamax( 2, x, 2 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array( [ 3.0, -4.0, 1.0, 15.0, 4.0, 3.0 ] ); + expected = 1; + + idx = icamax( 3, x, -1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + // eslint-disable-next-line max-len + x = new Complex64Array( [ 0.1, 4.0, 999.0, 999.0, -0.3, 6.0, 999.0, 999.0, -0.5, 7.0, 999.0, 999.0, -0.1, 3.0 ] ); + expected = 1; + + idx = icamax( 4, x, -2 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var expected; + var idx; + var x0; + var x1; + + x0 = new Complex64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 0 + 5.0, // 1 + 6.0, // 1 + 7.0, // 2 + 8.0 // 2 + ]); + x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + expected = 2; + + idx = icamax( 3, x1, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/icamax/test/test.js b/lib/node_modules/@stdlib/blas/base/icamax/test/test.js new file mode 100644 index 000000000000..d3c3bf918e60 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/test/test.js @@ -0,0 +1,82 @@ +/** +* @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 proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); +var icamax = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof icamax, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof icamax.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 icamax = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( icamax, 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 icamax; + var main; + + main = require( './../lib/icamax.js' ); + + icamax = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( icamax, main, 'returns expected value' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/base/icamax/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/icamax/test/test.ndarray.js new file mode 100644 index 000000000000..98c03f39b4ac --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/icamax/test/test.ndarray.js @@ -0,0 +1,203 @@ +/** +* @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 Complex64Array = require( '@stdlib/array/complex64' ); +var icamax = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof icamax, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 4', function test( t ) { + t.strictEqual( icamax.length, 4, 'returns expected value' ); + t.end(); +}); + +tape( 'the function finds the index of the element with the maximum |Re(.)| + |Im(.)|', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 0.1, // 0 + -0.3, // 0 + 0.5, // 1 + -0.1, // 1 + -0.2, // 2 + 0.6, // 2 + -0.4, // 3 + 0.9 // 3 + ]); + expected = 3; + + idx = icamax( 4, x, 1, 0 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + x = new Complex64Array([ + 0.2, // 0 + -0.6, // 0 + 0.3, // 1 + 0.6, // 1 + 5.0, + 5.0 + ]); + expected = 1; + + idx = icamax( 2, x, 1, 0 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter less than `1`, the function returns `-1`', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 1.0, + 2.0, + 3.0, + 4.0 + ]); + expected = -1; + + idx = icamax( 0, x, 1, 0 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an `N` parameter equal to `1`, the function returns `0`', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 1.0, + 2.0, + 3.0, + 4.0 + ]); + expected = 0; + + idx = icamax( 1, x, 1, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 0.1, // 0 + 4.0, // 0 + -0.3, + 6.0, + -0.5, // 1 + 7.0, // 1 + -0.1, + 3.0 + ]); + expected = 1; + + idx = icamax( 2, x, 2, 0 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array( [ 3.0, -4.0, 1.0, 15.0, 4.0, 3.0 ] ); + expected = 1; + + idx = icamax( 3, x, -1, 2 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + // eslint-disable-next-line max-len + x = new Complex64Array( [ 0.1, 4.0, 999.0, 999.0, -0.3, 6.0, 999.0, 999.0, -0.5, 7.0, 999.0, 999.0, -0.1, 3.0 ] ); + expected = 1; + + idx = icamax( 4, x, -2, 6 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying an `x` offset', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 0 + 5.0, // 1 + 6.0, // 1 + 7.0, // 2 + 8.0 // 2 + ]); + expected = 2; + + idx = icamax( 3, x, 1, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports complex access patterns', function test( t ) { + var expected; + var idx; + var x; + + x = new Complex64Array([ + 1.0, + 2.0, + 3.0, // 0 + 4.0, // 0 + 5.0, + 6.0, + 7.0, // 1 + 8.0 // 1 + ]); + expected = 1; + + idx = icamax( 2, x, 2, 1 ); + t.strictEqual( idx, expected, 'returns expected value' ); + + t.end(); +});