index.js (1636B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Create an ndarray function interface which performs multiple dispatch. 23 * 24 * @module @stdlib/ndarray/dispatch 25 * 26 * @example 27 * var dispatch = require( '@stdlib/ndarray/dispatch' ); 28 * var ndarray = require( '@stdlib/ndarray/ctor' ); 29 * var unary = require( '@stdlib/ndarray/base/unary' ); 30 * var abs = require( '@stdlib/math/base/special/abs' ); 31 * var Float64Array = require( '@stdlib/array/float64' ); 32 * 33 * var types = [ 34 * 'float64', 'float64' 35 * ]; 36 * 37 * var data = [ 38 * abs 39 * ]; 40 * 41 * var absolute = dispatch( unary, types, data, 2, 1, 1 ); 42 * 43 * // ... 44 * 45 * var xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] ); 46 * var ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] ); 47 * 48 * var x = ndarray( 'float64', xbuf, [ 5 ], [ 1 ], 0, 'row-major' ); 49 * var y = ndarray( 'float64', ybuf, [ 5 ], [ 1 ], 0, 'row-major' ); 50 * 51 * absolute( x, y ); 52 * // ybuf => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ] 53 */ 54 55 // MODULES // 56 57 var dispatch = require( './main.js' ); 58 59 60 // EXPORTS // 61 62 module.exports = dispatch;