ndarray.js (1730B)
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' ).ndarray; 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 {NonNegativeInteger} offsetX - starting index for `x` 36 * @param {NumericArray} y - output array 37 * @param {integer} strideY - `y` stride length 38 * @param {NonNegativeInteger} offsetY - starting index for `y` 39 * @returns {NumericArray} output array 40 * 41 * @example 42 * var floor = require( '@stdlib/math/base/special/floor' ); 43 * 44 * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; 45 * var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; 46 * var N = floor( x.length / 2 ); 47 * 48 * gcusum( N, 0.0, x, 2, 1, y, 1, 0 ); 49 * // y => [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ] 50 */ 51 function gcusum( N, sum, x, strideX, offsetX, y, strideY, offsetY ) { 52 return gcusumkbn( N, sum, x, strideX, offsetX, y, strideY, offsetY ); 53 } 54 55 56 // EXPORTS // 57 58 module.exports = gcusum;