stdlib-js / ndarray-dispatch-by

Create an ndarray function interface which accepts a callback function and performs multiple dispatch.

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

dispatchBy

Create an ndarray function interface which performs multiple dispatch.

Installation

npm install @stdlib/ndarray-dispatch-by

Alternatively,

• To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
• If you are using Deno, visit the deno branch (see README for usage intructions).
• For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

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 by nin+nout. If fcns is a function, rather than a list, the number of ndarray functions is computed as types.length / (nin+nout).
• data: ndarray function data (e.g., callbacks). If a list, the length of data must equal the number of ndarray functions. If null, a returned ndarray function interface does not provide a data 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

  • x: ndarray.
  • y: ndarray.
  • ...: additional ndarrays.

• The number of ndarray function interface parameters is derived from nargs, the number of input ndarrays is derived from nin, and the number of output ndarrays is derived from nout.

• An ndarray function (i.e., a value provided for the fcns argument) should have the following signature:

  f( arrays[, data] )
  

  where

  • arrays: array containing input and output ndarrays.
  • data: ndarray function data (e.g., a callback).

• 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 function data differs (e.g., callbacks which differ based on the array data types). For example, the following

  var 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.