time-to-botec

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

ndarray.js (2646B)


      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 abs = require( '@stdlib/math/base/special/abs' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Adds a constant to each single-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.
     31 *
     32 * ## Method
     33 *
     34 * -   This implementation uses an "improved Kahan–Babuška algorithm", as described by Neumaier (1974).
     35 *
     36 * ## References
     37 *
     38 * -   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).
     39 *
     40 * @param {PositiveInteger} N - number of indexed elements
     41 * @param {number} alpha - constant
     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 ] );
     52 * var N = floor( x.length / 2 );
     53 *
     54 * var v = sapxsumkbn( N, 5.0, x, 2, 1 );
     55 * // returns 25.0
     56 */
     57 function sapxsumkbn( N, alpha, x, stride, offset ) {
     58 	var sum;
     59 	var ix;
     60 	var v;
     61 	var t;
     62 	var c;
     63 	var i;
     64 
     65 	if ( N <= 0 ) {
     66 		return 0.0;
     67 	}
     68 	if ( N === 1 || stride === 0 ) {
     69 		return float64ToFloat32( alpha + x[ offset ] );
     70 	}
     71 	ix = offset;
     72 	sum = 0.0;
     73 	c = 0.0;
     74 	for ( i = 0; i < N; i++ ) {
     75 		v = float64ToFloat32( alpha + x[ ix ] );
     76 		t = float64ToFloat32( sum + v );
     77 		if ( abs( sum ) >= abs( v ) ) {
     78 			c = float64ToFloat32( c + float64ToFloat32( float64ToFloat32( sum-t ) + v ) ); // eslint-disable-line max-len
     79 		} else {
     80 			c = float64ToFloat32( c + float64ToFloat32( float64ToFloat32( v-t ) + sum ) ); // eslint-disable-line max-len
     81 		}
     82 		sum = t;
     83 		ix += stride;
     84 	}
     85 	return float64ToFloat32( sum + c );
     86 }
     87 
     88 
     89 // EXPORTS //
     90 
     91 module.exports = sapxsumkbn;