time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

gnansumpw.js (2052B)

      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 isnan = require( '@stdlib/math/base/assert/is-nan' );
     24 var sum = require( './ndarray.js' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Computes the sum of strided array elements, ignoring `NaN` values and using pairwise summation.
     31 *
     32 * ## Method
     33 *
     34 * -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.
     35 *
     36 * ## References
     37 *
     38 * -   Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
     39 *
     40 * @param {PositiveInteger} N - number of indexed elements
     41 * @param {NumericArray} x - input array
     42 * @param {integer} stride - stride length
     43 * @returns {number} sum
     44 *
     45 * @example
     46 * var x = [ 1.0, -2.0, NaN, 2.0 ];
     47 * var N = x.length;
     48 *
     49 * var v = gnansumpw( N, x, 1 );
     50 * // returns 1.0
     51 */
     52 function gnansumpw( N, x, stride ) {
     53 	var ix;
     54 	var s;
     55 	var i;
     56 
     57 	if ( N <= 0 ) {
     58 		return 0.0;
     59 	}
     60 	if ( N === 1 || stride === 0 ) {
     61 		if ( isnan( x[ 0 ] ) ) {
     62 			return 0.0;
     63 		}
     64 		return x[ 0 ];
     65 	}
     66 	if ( stride < 0 ) {
     67 		ix = (1-N) * stride;
     68 	} else {
     69 		ix = 0;
     70 	}
     71 	if ( N < 8 ) {
     72 		// Use simple summation...
     73 		s = 0.0;
     74 		for ( i = 0; i < N; i++ ) {
     75 			if ( isnan( x[ ix ] ) === false ) {
     76 				s += x[ ix ];
     77 			}
     78 			ix += stride;
     79 		}
     80 		return s;
     81 	}
     82 	return sum( N, x, stride, ix );
     83 }
     84 
     85 
     86 // EXPORTS //
     87 
     88 module.exports = gnansumpw;