pickArguments

Create a function that invokes a provided function with specified arguments.

Installation

npm install @stdlib/utils-pick-arguments

Usage

var pickArguments = require( '@stdlib/utils-pick-arguments' );

pickArguments( fcn, indices[, thisArg] )

Returns a function that invokes a provided function with specified arguments.

function foo( a, b ) {
    return [ a, b ];
}

var bar = pickArguments( foo, [ 0, 2 ] );

var out = bar( 1, 2, 3 );
// returns [ 1, 3 ]

To set the this context when invoking the provided function, provide a thisArg.

function Foo() {
    this.x = 1;
    this.y = 2;
}

Foo.prototype.scale = function scale( a, b ) {
    return [ this.x*a, this.y*b ];
};

var ctx = {
    'x': 10,
    'y': 20
};

var foo = new Foo();

var bar = pickArguments( foo.scale, [ 0, 2 ], ctx );

var out = bar( 1, 2, 3 );
// returns [ 10, 60 ]

Examples

var filledarrayBy = require( '@stdlib/array-filled-by' );
var add = require( '@stdlib/math-base-ops-add' );
var pickArguments = require( '@stdlib/utils-pick-arguments' );

function fill( i ) {
    return i;
}

// Create a data array:
var x = filledarrayBy( 10, 'float64', fill );

// Compute the sum of consecutive elements...
var f;
var i;
for ( i = 1; i < x.length; i++ ) {
    f = pickArguments( add, [ i-1, i ] );
    console.log( 'sum(x_%d, x_%d) = %d', i-1, i, f.apply( null, x ) );
}

See Also

• @stdlib/utils-reorder-arguments: create a function that invokes a provided function with reordered arguments.
• @stdlib/utils-reverse-arguments: create a function that invokes a provided function with arguments in reverse order.

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.