index.js (1452B)
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 vectors `x` and `y`. 23 * 24 * @module @stdlib/blas/base/gdot 25 * 26 * @example 27 * var gdot = require( '@stdlib/blas/base/gdot' ); 28 * 29 * var x = [ 4.0, 2.0, -3.0, 5.0, -1.0 ]; 30 * var y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ]; 31 * 32 * var z = gdot( x.length, x, 1, y, 1 ); 33 * // returns -5.0 34 * 35 * 36 * @example 37 * var gdot = require( '@stdlib/blas/base/gdot' ); 38 * 39 * var x = [ 4.0, 2.0, -3.0, 5.0, -1.0 ]; 40 * var y = [ 2.0, 6.0, -1.0, -4.0, 8.0 ]; 41 * 42 * var z = gdot.ndarray( x.length, x, 1, 0, y, 1, 0 ); 43 * // returns -5.0 44 */ 45 46 // MODULES // 47 48 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 49 var gdot = require( './main.js' ); 50 var ndarray = require( './ndarray.js' ); 51 52 53 // MAIN // 54 55 setReadOnly( gdot, 'ndarray', ndarray ); 56 57 58 // EXPORTS // 59 60 module.exports = gdot;