time-to-botec

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

scusumpw.js (2127B)

      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 cusum = require( './ndarray.js' );
     24 
     25 
     26 // MAIN //
     27 
     28 /**
     29 * Computes the cumulative sum of single-precision floating-point strided array elements using pairwise summation.
     30 *
     31 * ## Method
     32 *
     33 * -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.
     34 *
     35 * ## References
     36 *
     37 * -   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).
     38 *
     39 * @param {PositiveInteger} N - number of indexed elements
     40 * @param {number} sum - initial sum
     41 * @param {Float32Array} x - input array
     42 * @param {integer} strideX - `x` stride length
     43 * @param {Float32Array} y - output array
     44 * @param {integer} strideY - `y` stride length
     45 * @returns {Float32Array} output array
     46 *
     47 * @example
     48 * var Float32Array = require( '@stdlib/array/float32' );
     49 *
     50 * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
     51 * var y = new Float32Array( x.length );
     52 * var N = x.length;
     53 *
     54 * var v = scusumpw( N, 0.0, x, 1, y, 1 );
     55 * // returns <Float32Array>[ 1.0, -1.0, 1.0 ]
     56 */
     57 function scusumpw( N, sum, x, strideX, y, strideY ) {
     58 	var ix;
     59 	var iy;
     60 
     61 	if ( N <= 0 ) {
     62 		return y;
     63 	}
     64 	if ( strideX < 0 ) {
     65 		ix = (1-N) * strideX;
     66 	} else {
     67 		ix = 0;
     68 	}
     69 	if ( strideY < 0 ) {
     70 		iy = (1-N) * strideY;
     71 	} else {
     72 		iy = 0;
     73 	}
     74 	return cusum( N, sum, x, strideX, ix, y, strideY, iy );
     75 }
     76 
     77 
     78 // EXPORTS //
     79 
     80 module.exports = scusumpw;