gsum.js (1156B)
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 gsumkbn = require( './../../../../ext/base/gsumkbn' ); 24 25 26 // MAIN // 27 28 /** 29 * Computes the sum of strided array elements. 30 * 31 * @param {PositiveInteger} N - number of indexed elements 32 * @param {NumericArray} x - input array 33 * @param {integer} stride - stride length 34 * @returns {number} sum 35 * 36 * @example 37 * var x = [ 1.0, -2.0, 2.0 ]; 38 * var N = x.length; 39 * 40 * var v = gsum( N, x, 1 ); 41 * // returns 1.0 42 */ 43 function gsum( N, x, stride ) { 44 return gsumkbn( N, x, stride ); 45 } 46 47 48 // EXPORTS // 49 50 module.exports = gsum;