diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/README.md b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/README.md new file mode 100644 index 000000000000..eccfeba80e66 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/README.md @@ -0,0 +1,100 @@ + + +# igamax + +> Find the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray. + +
+ +## Usage + +```javascript +var igamax = require( '@stdlib/blas/base/ndarray/igamax' ); +``` + +#### igamax( arrays ) + +Finds the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray. + +```javascript +var vector = require( '@stdlib/ndarray/vector/ctor' ); + +var x = vector( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ], 'generic' ); + +var idx = igamax( [ x ] ); +// returns 3 +``` + +The function has the following parameters: + +- **arrays**: array-like object containing a one-dimensional input ndarray. + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var igamax = require( '@stdlib/blas/base/ndarray/igamax' ); + +var opts = { + 'dtype': 'generic' +}; + +var x = discreteUniform( [ 10 ], -500, 500, opts ); +console.log( ndarray2array( x ) ); + +var out = igamax( [ x ] ); +console.log( out ); +``` + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/benchmark/benchmark.js new file mode 100644 index 000000000000..04b904a8f36b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/benchmark/benchmark.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var igamax = require( './../lib' ); + + +// VARIABLES // + +var options = { + 'dtype': 'generic' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x = uniform( [ len ], -100.0, 100.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = igamax( [ x ] ); + if ( isnan( z ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z ) ) { + 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( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/repl.txt new file mode 100644 index 000000000000..854eeb38ed01 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/repl.txt @@ -0,0 +1,26 @@ + +{{alias}}( arrays ) + Finds the index of the first element having the maximum absolute value + for all elements in a one-dimensional ndarray. + + If provided an empty input ndarray, the function returns `-1`. + + Parameters + ---------- + arrays: ArrayLikeObject + Array-like object containing a one-dimensional input ndarray. + + Returns + ------- + out: integer + The index of the first element having the maximum absolute value. + + Examples + -------- + > var x = {{alias:@stdlib/ndarray/vector/ctor}}( [ 1.0, -2.0, 3.0, -4.0, 5.0 ], 'generic' ); + > {{alias}}( [ x ] ) + 4 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/types/index.d.ts new file mode 100644 index 000000000000..7498bf59495c --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/types/index.d.ts @@ -0,0 +1,50 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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 { typedndarray } from '@stdlib/types/ndarray'; + +/** +* Finds the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* +* @param arrays - array-like object containing ndarrays +* @returns index value +* +* @example +* var vector = require( '@stdlib/ndarray/vector/ctor' ); +* +* var x = vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ], 'generic' ); +* +* var y = igamax( [ x ] ); +* // returns 4 +*/ +declare function igamax( arrays: [ typedndarray ] ): number; + + +// EXPORTS // + +export = igamax; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/types/test.ts new file mode 100644 index 000000000000..8e7e7603b8db --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/docs/types/test.ts @@ -0,0 +1,57 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 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. +*/ + +/* eslint-disable space-in-parens */ + +import zeros = require( '@stdlib/ndarray/zeros' ); +import igamax = require( './index' ); + + +// TESTS // + +// The function returns a number... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + igamax( [ x ] ); // $ExpectType number +} + +// The compiler throws an error if the function is provided a first argument which is not an array of ndarrays... +{ + igamax( '10' ); // $ExpectError + igamax( 10 ); // $ExpectError + igamax( true ); // $ExpectError + igamax( false ); // $ExpectError + igamax( null ); // $ExpectError + igamax( undefined ); // $ExpectError + igamax( [] ); // $ExpectError + igamax( {} ); // $ExpectError + igamax( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = zeros( [ 10 ], { + 'dtype': 'generic' + }); + + igamax(); // $ExpectError + igamax( [ x ], {} ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/examples/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/examples/index.js new file mode 100644 index 000000000000..31c4917b2b52 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/examples/index.js @@ -0,0 +1,33 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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/discrete-uniform' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var igamax = require( './../lib' ); + +var opts = { + 'dtype': 'generic' +}; + +var x = discreteUniform( [ 10 ], -500, 500, opts ); +console.log( ndarray2array( x ) ); + +var out = igamax( [ x ] ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/lib/index.js b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/lib/index.js new file mode 100644 index 000000000000..6d70648d4957 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/lib/index.js @@ -0,0 +1,43 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 the maximum absolute value for all elements in a one-dimensional ndarray. +* +* @module @stdlib/blas/base/ndarray/igamax +* +* @example +* var vector = require( '@stdlib/ndarray/vector/ctor' ); +* var igamax = require( '@stdlib/blas/base/ndarray/igamax' ); +* +* var x = vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ], 'generic' ); +* +* var y = igamax( [ x ] ); +* // returns 4 +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/lib/main.js b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/lib/main.js new file mode 100644 index 000000000000..ae9189277104 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/lib/main.js @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStride = require( '@stdlib/ndarray/base/stride' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var strided = require( '@stdlib/blas/base/igamax' ).ndarray; + + +// MAIN // + +/** +* Finds the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray. +* +* ## Notes +* +* - The function expects the following ndarrays: +* +* - a one-dimensional input ndarray. +* +* @param {ArrayLikeObject} arrays - array-like object containing ndarrays +* @returns {integer} index value +* +* @example +* var vector = require( '@stdlib/ndarray/vector/ctor' ); +* +* var x = vector( [ 1.0, -2.0, 3.0, -4.0, 5.0 ], 'generic' ); +* +* var y = igamax( [ x ] ); +* // returns 4 +*/ +function igamax( arrays ) { + var x = arrays[ 0 ]; + return strided( numelDimension( x, 0 ), getData( x ), getStride( x, 0 ), getOffset( x ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = igamax; diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/package.json b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/package.json new file mode 100644 index 000000000000..ba1f70f9bc03 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/package.json @@ -0,0 +1,72 @@ +{ + "name": "@stdlib/blas/base/ndarray/igamax", + "version": "0.0.0", + "description": "Find the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray.", + "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", + "linear", + "algebra", + "subroutines", + "igamax", + "amax", + "max", + "index", + "generic", + "absolute", + "absolute value", + "norm", + "vector", + "ndarray" + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/ndarray/igamax/test/test.js b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/test/test.js new file mode 100644 index 000000000000..0733d052f587 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/ndarray/igamax/test/test.js @@ -0,0 +1,153 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 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 ndarray = require( '@stdlib/ndarray/base/ctor' ); +var igamax = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Returns a one-dimensional ndarray. +* +* @private +* @param {Collection} buffer - underlying data buffer +* @param {NonNegativeInteger} length - number of indexed elements +* @param {integer} stride - stride length +* @param {NonNegativeInteger} offset - index offset +* @returns {ndarray} one-dimensional ndarray +*/ +function vector( buffer, length, stride, offset ) { + return new ndarray( 'generic', buffer, [ length ], [ stride ], offset, 'row-major' ); +} + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof igamax, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 1', function test( t ) { + t.strictEqual( igamax.length, 1, 'has expected arity' ); + t.end(); +}); + +tape( 'the function finds the index of the first element having the maximum absolute value for all elements in a one-dimensional ndarray', function test( t ) { + var xbuf; + var x; + var y; + + xbuf = [ 1.0, -2.0, 3.0, -4.0, 5.0 ]; + x = vector( xbuf, 5, 1, 0 ); + y = igamax( [ x ] ); + + t.strictEqual( y, 4, 'returns expected value' ); + + xbuf = [ -4.0, -2.0 ]; + x = vector( xbuf, 2, 1, 0 ); + y = igamax( [ x ] ); + + t.strictEqual( y, 0, 'returns expected value' ); + + t.end(); +}); + +tape( 'if provided an empty ndarray, the function returns `-1`', function test( t ) { + var xbuf; + var x; + var y; + + xbuf = []; + x = vector( xbuf, 0, 1, 0 ); + + y = igamax( [ x ] ); + t.strictEqual( y, -1, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-unit strides', function test( t ) { + var xbuf; + var x; + var y; + + xbuf = [ + 1.0, // 0 + -3.0, + -5.0, // 1 + 7.0, + 6.0 // 2 + ]; + x = vector( xbuf, 3, 2, 0 ); + + y = igamax( [ x ] ); + t.strictEqual( y, 2, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having negative strides', function test( t ) { + var xbuf; + var x; + var y; + + xbuf = [ + 1.0, // 2 + 2.0, + 3.0, // 1 + 4.0, + 5.0 // 0 + ]; + x = vector( xbuf, 3, -2, 4 ); + + y = igamax( [ x ] ); + t.strictEqual( y, 0, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports one-dimensional ndarrays having non-zero offsets', function test( t ) { + var xbuf; + var x; + var y; + + xbuf = [ + 2.0, + 1.0, // 0 + 2.0, + -2.0, // 1 + -2.0, + 2.0, // 2 + 3.0, + 4.0 // 3 + ]; + x = vector( xbuf, 4, 2, 1 ); + + y = igamax( [ x ] ); + t.strictEqual( y, 3, 'returns expected value' ); + + t.end(); +});