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