ndarray.js (2559B)
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 double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm. 30 * 31 * ## Method 32 * 33 * - This implementation uses an "improved Kahan–Babuška algorithm", as described by Neumaier (1974). 34 * 35 * ## References 36 * 37 * - Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106](https://doi.org/10.1002/zamm.19740540106). 38 * 39 * @param {PositiveInteger} N - number of indexed elements 40 * @param {number} sum - initial sum 41 * @param {Float64Array} x - input array 42 * @param {integer} strideX - `x` stride length 43 * @param {NonNegativeInteger} offsetX - starting index for `x` 44 * @param {Float64Array} y - output array 45 * @param {integer} strideY - `y` stride length 46 * @param {NonNegativeInteger} offsetY - starting index for `y` 47 * @returns {Float64Array} output array 48 * 49 * @example 50 * var Float64Array = require( '@stdlib/array/float64' ); 51 * var floor = require( '@stdlib/math/base/special/floor' ); 52 * 53 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); 54 * var y = new Float64Array( x.length ); 55 * var N = floor( x.length / 2 ); 56 * 57 * var v = dcusumkbn( N, 0.0, x, 2, 1, y, 1, 0 ); 58 * // returns <Float64Array>[ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ] 59 */ 60 function dcusumkbn( N, sum, x, strideX, offsetX, y, strideY, offsetY ) { 61 var ix; 62 var iy; 63 var s; 64 var v; 65 var t; 66 var c; 67 var i; 68 69 if ( N <= 0 ) { 70 return y; 71 } 72 ix = offsetX; 73 iy = offsetY; 74 s = sum; 75 c = 0.0; 76 for ( i = 0; i < N; i++ ) { 77 v = x[ ix ]; 78 t = s + v; 79 if ( abs( s ) >= abs( v ) ) { 80 c += (s-t) + v; 81 } else { 82 c += (v-t) + s; 83 } 84 s = t; 85 y[ iy ] = s + c; 86 ix += strideX; 87 iy += strideY; 88 } 89 return y; 90 } 91 92 93 // EXPORTS // 94 95 module.exports = dcusumkbn;