Argument Function

Create an argument function.

Installation

npm install @stdlib/utils-argument-function

Usage

var argumentFunction = require( '@stdlib/utils-argument-function' );

argumentFunction( idx )

Returns a function which always returns an argument corresponding to a specified argument index.

var argn = argumentFunction( 1 );
// returns <Function>

var v = argn( 1.0, 2.0, 3.0 );
// returns 2.0

v = argn( 'a', 'b', 'c' );
// returns 'b'

If an argument function is provided fewer arguments than the specified argument index, an argument function returns undefined.

var argn = argumentFunction( 100 );
// returns <Function>

var v = argn( 1.0 );
// returns undefined

Notes

• Argument indices are zero-based.

Examples

var randu = require( '@stdlib/random-base-randu' );
var argumentFunction = require( '@stdlib/utils-argument-function' );

var argn;
var v;
var i;

argn = argumentFunction( 1 );
for ( i = 0; i < 10; i++ ) {
    v = argn( randu(), randu()*10.0, randu()*100.0 );
    console.log( v );
}

See Also

• @stdlib/utils-constant-function: constant function.
• @stdlib/utils-identity-function: identity function.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.