ndarray.js (2998B)
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 float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' ); 24 var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); 25 var abs = require( '@stdlib/math/base/special/abs' ); 26 27 28 // MAIN // 29 30 /** 31 * Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm. 32 * 33 * ## Method 34 * 35 * - This implementation uses a second-order iterative Kahan–Babuška algorithm, as described by Klein (2005). 36 * 37 * ## References 38 * 39 * - 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). 40 * 41 * @param {PositiveInteger} N - number of indexed elements 42 * @param {Float32Array} x - input array 43 * @param {integer} stride - stride length 44 * @param {NonNegativeInteger} offset - starting index 45 * @returns {number} sum 46 * 47 * @example 48 * var Float32Array = require( '@stdlib/array/float32' ); 49 * var floor = require( '@stdlib/math/base/special/floor' ); 50 * 51 * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] ); 52 * var N = floor( x.length / 2 ); 53 * 54 * var v = snansumkbn2( N, x, 2, 1 ); 55 * // returns 5.0 56 */ 57 function snansumkbn2( N, x, stride, offset ) { 58 var sum; 59 var ccs; 60 var ix; 61 var cs; 62 var cc; 63 var v; 64 var t; 65 var c; 66 var i; 67 68 if ( N <= 0 ) { 69 return 0.0; 70 } 71 if ( N === 1 || stride === 0 ) { 72 if ( isnanf( x[ offset ] ) ) { 73 return 0.0; 74 } 75 return x[ offset ]; 76 } 77 ix = offset; 78 sum = 0.0; 79 ccs = 0.0; // second order correction term for lost low order bits 80 cs = 0.0; // first order correction term for lost low order bits 81 for ( i = 0; i < N; i++ ) { 82 v = x[ ix ]; 83 if ( isnanf( v ) === false ) { 84 t = float64ToFloat32( sum + v ); 85 if ( abs( sum ) >= abs( v ) ) { 86 c = float64ToFloat32( float64ToFloat32( sum-t ) + v ); 87 } else { 88 c = float64ToFloat32( float64ToFloat32( v-t ) + sum ); 89 } 90 sum = t; 91 t = float64ToFloat32( cs + c ); 92 if ( abs( cs ) >= abs( c ) ) { 93 cc = float64ToFloat32( float64ToFloat32(cs-t) + c ); 94 } else { 95 cc = float64ToFloat32( float64ToFloat32(c-t) + cs ); 96 } 97 cs = t; 98 ccs = float64ToFloat32( ccs + cc ); 99 } 100 ix += stride; 101 } 102 return float64ToFloat32( sum + float64ToFloat32( cs + ccs ) ); 103 } 104 105 106 // EXPORTS // 107 108 module.exports = snansumkbn2;