Auto-generated commit

Author: stdlib-bot

docs/types/index.d.ts

@@ -25,6 +25,7 @@ import array = require( './../../array' );
 import base = require( './../../base' );
 import ndarrayCastingModes = require( './../../casting-modes' );
 import ndarray = require( './../../ctor' );
+import dispatch = require( './../../dispatch' );
 import ndarrayDataTypes = require( './../../dtypes' );
 import scalar2ndarray = require( './../../from-scalar' );
 import ind2sub = require( './../../ind2sub' );
@@ -162,6 +163,56 @@ interface Namespace {
 	*/
 	ndarray: typeof ndarray;
 
+	/**
+	* Returns an ndarray function interface which performs multiple dispatch.
+	*
+	* @param fcns - list of ndarray functions
+	* @param types - one-dimensional list of ndarray argument data types
+	* @param data - ndarray function data (e.g., callbacks)
+	* @param nargs - total number of ndarray function interface arguments
+	* @param nin - number of input ndarrays
+	* @param nout - number of output ndarrays
+	* @throws first argument must be either a function or an array of functions
+	* @throws second argument must be an array-like object
+	* @throws third argument must be an array-like object or `null`
+	* @throws third and first arguments must have the same number of elements
+	* @throws fourth argument must be a positive integer
+	* @throws fifth argument must be a nonnegative integer
+	* @throws sixth argument must be a nonnegative integer
+	* @throws fourth argument must equal the specified number of input and output arrays
+	* @throws number of types must match the number of functions times the total number of array arguments for each function
+	* @throws interface must accept at least one input and/or output ndarray
+	* @returns ndarray function interface
+	*
+	* @example
+	* var unary = require( `@stdlib/ndarray/base/unary` );
+	* var abs = require( `@stdlib/math/base/special/abs` );
+	* var Float64Array = require( `@stdlib/array/float64` );
+	* var ndarray = require( `@stdlib/ndarray/ctor` );
+	*
+	* var types = [
+	*     'float64', 'float64'
+	* ];
+	*
+	* var data = [
+	*     abs
+	* ];
+	*
+	* var fcn = ns.dispatch( unary, types, data, 2, 1, 1 );
+	*
+	* // ...
+	*
+	* var xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] );
+	* var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
+	*
+	* var x = ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' );
+	* var y = ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' );
+	*
+	* fcn( x, y );
+	* // ybuf => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
+	*/
+	dispatch: typeof dispatch;
+
 	/**
 	* Returns a list of ndarray data types.
 	*