@stdlib/ndarray-dispatch-by
v0.2.2
Published
Create an ndarray function interface which accepts a callback function and performs multiple dispatch.
Downloads
12
Readme
dispatchBy
Create an ndarray function interface which performs multiple dispatch.
Installation
npm install @stdlib/ndarray-dispatch-by
Usage
var dispatchBy = require( '@stdlib/ndarray-dispatch-by' );
dispatchBy( fcns, types, data, nargs, nin, nout )
Returns an ndarray function interface which performs multiple dispatch.
console.log( 'TODO' );
The function accepts the following arguments:
- fcns: list of ndarray functions.
- types: one-dimensional list of ndarray argument data types. The length of
types
must be the number of ndarray functions multiplied bynin+nout
. Iffcns
is a function, rather than a list, the number of ndarray functions is computed astypes.length / (nin+nout)
. - data: ndarray function data (e.g., callbacks). If a list, the length of
data
must equal the number of ndarray functions. Ifnull
, a returned ndarray function interface does not provide adata
argument to an invoked ndarray function. - nargs: total number of ndarray function interface arguments.
- nin: number of input ndarrays.
- nout: number of output ndarrays.
Notes
A returned ndarray function interface has the following signature:
f( x, y, ... )
where
The number of ndarray function interface parameters is derived from
nargs
, the number of input ndarrays is derived fromnin
, and the number of output ndarrays is derived fromnout
.An ndarray function (i.e., a value provided for the
fcns
argument) should have the following signature:f( arrays[, data] )
where
For convenience, a single ndarray function may be provided which will be invoked whenever the ndarray argument data types match a sequence of types in
types
. Providing a single ndarray function is particularly convenient for the case where, regardless of array data types, traversing arrays remains the same, but the ndarray functiondata
differs (e.g., callbacks which differ based on the array data types). For example, the followingvar unary = require( '@stdlib/ndarray-base-unary-by' ); function foo( x ) { return x * 10.0; } function bar( x ) { return x * 5.0; } var fcns = [ unary, unary ]; var types = [ 'float64', 'float64', 'float32', 'float32' ]; var data = [ foo, bar ]; var fcn = dispatchBy( fcns, types, data, 2, 1, 1 );
is equivalent to
var unary = require( '@stdlib/ndarray-base-unary-by' ); function foo( x ) { return x * 10.0; } function bar( x ) { return x * 5.0; } var types = [ 'float64', 'float64', 'float32', 'float32' ]; var data = [ foo, bar ]; var fcn = dispatchBy( unary, types, data, 2, 1, 1 );
Examples
console.log( 'TODO' );
See Also
@stdlib/ndarray-array
: multidimensional arrays.@stdlib/ndarray-ctor
: multidimensional array constructor.
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.