time-to-botec

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

index.js (1210B)


      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 * BLAS level 1 routine to compute the dot product of two double-precision floating-point vectors.
     23 *
     24 * @module @stdlib/blas/ddot
     25 *
     26 * @example
     27 * var Float64Array = require( '@stdlib/array/float64' );
     28 * var array = require( '@stdlib/ndarray/array' );
     29 * var ddot = require( '@stdlib/blas/ddot' );
     30 *
     31 * var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );
     32 * var y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );
     33 *
     34 * var z = ddot( x, y );
     35 * // returns -5.0
     36 */
     37 
     38 // MODULES //
     39 
     40 var ddot = require( './main.js' );
     41 
     42 
     43 // EXPORTS //
     44 
     45 module.exports = ddot;