ndarray.js (2685B)
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 abs = require( '@stdlib/math/base/special/abs' ); 24 25 26 // MAIN // 27 28 /** 29 * Computes the cumulative sum of strided array elements using a second-order iterative Kahan–Babuška algorithm. 30 * 31 * ## Method 32 * 33 * - This implementation uses a second-order iterative Kahan–Babuška algorithm, as described by Klein (2005). 34 * 35 * ## References 36 * 37 * - Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x). 38 * 39 * @param {PositiveInteger} N - number of indexed elements 40 * @param {number} sum - initial sum 41 * @param {NumericArray} x - input array 42 * @param {integer} strideX - `x` stride length 43 * @param {NonNegativeInteger} offsetX - starting index for `x` 44 * @param {NumericArray} y - output array 45 * @param {integer} strideY - `y` stride length 46 * @param {NonNegativeInteger} offsetY - starting index for `y` 47 * @returns {NumericArray} output array 48 * 49 * @example 50 * var floor = require( '@stdlib/math/base/special/floor' ); 51 * 52 * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ]; 53 * var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ]; 54 * var N = floor( x.length / 2 ); 55 * 56 * gcusumkbn2( N, 0.0, x, 2, 1, y, 1, 0 ); 57 * // y => [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ] 58 */ 59 function gcusumkbn2( N, sum, x, strideX, offsetX, y, strideY, offsetY ) { 60 var ccs; 61 var ix; 62 var iy; 63 var cs; 64 var cc; 65 var v; 66 var t; 67 var c; 68 var i; 69 70 if ( N <= 0 ) { 71 return y; 72 } 73 ix = offsetX; 74 iy = offsetY; 75 76 ccs = 0.0; // second order correction term for lost low order bits 77 cs = 0.0; // first order correction term for lost low order bits 78 for ( i = 0; i < N; i++ ) { 79 v = x[ ix ]; 80 t = sum + v; 81 if ( abs( sum ) >= abs( v ) ) { 82 c = (sum-t) + v; 83 } else { 84 c = (v-t) + sum; 85 } 86 sum = t; 87 t = cs + c; 88 if ( abs( cs ) >= abs( c ) ) { 89 cc = (cs-t) + c; 90 } else { 91 cc = (c-t) + cs; 92 } 93 cs = t; 94 ccs += cc; 95 96 y[ iy ] = sum + cs + ccs; 97 ix += strideX; 98 iy += strideY; 99 } 100 return y; 101 } 102 103 104 // EXPORTS // 105 106 module.exports = gcusumkbn2;