time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1457B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2020 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 a strided array function interface which performs multiple dispatch.
     23 *
     24 * @module @stdlib/strided/dispatch
     25 *
     26 * @example
     27 * var dispatch = require( '@stdlib/strided/dispatch' );
     28 * var unary = require( '@stdlib/strided/base/unary' );
     29 * var abs = require( '@stdlib/math/base/special/abs' );
     30 * var Float64Array = require( '@stdlib/array/float64' );
     31 *
     32 * var types = [
     33 *     'float64', 'float64'
     34 * ];
     35 *
     36 * var data = [
     37 *     abs
     38 * ];
     39 *
     40 * var strided = dispatch( unary, types, data, 5, 1, 1 );
     41 *
     42 * // ...
     43 *
     44 * var x = new Float64Array( [ -1.0, -2.0, -3.0, -4.0, -5.0 ] );
     45 * var y = new Float64Array( [ 0.0, 0.0, 0.0, 0.0, 0.0 ] );
     46 *
     47 * strided( x.length, x, 1, y, 1 );
     48 * // y => <Float64Array>[ 1.0, 2.0, 3.0, 4.0, 5.0 ]
     49 */
     50 
     51 // MODULES //
     52 
     53 var dispatch = require( './main.js' );
     54 
     55 
     56 // EXPORTS //
     57 
     58 module.exports = dispatch;