dsdot.native.js (1506B)
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 // MODULES // 22 23 var addon = require( './../src/addon.node' ); 24 25 26 // MAIN // 27 28 /** 29 * Computes the dot product of `x` and `y` with extended accumulation and result. 30 * 31 * @param {PositiveInteger} N - number of values over which to compute the dot product 32 * @param {Float32Array} x - first input array 33 * @param {integer} strideX - `x` stride length 34 * @param {Float32Array} y - second input array 35 * @param {integer} strideY - `y` stride length 36 * @returns {number} dot product of `x` and `y` 37 * 38 * @example 39 * var Float32Array = require( '@stdlib/array/float32' ); 40 * 41 * var x = new Float32Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ); 42 * var y = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ); 43 * 44 * var z = dsdot( x.length, x, 1, y, 1 ); 45 * // returns -5.0 46 */ 47 function dsdot( N, x, strideX, y, strideY ) { 48 return addon( N, x, strideX, y, strideY ); 49 } 50 51 52 // EXPORTS // 53 54 module.exports = dsdot;