All files / blas/ext/base/snannsumpw/lib ndarray.js

100% Statements 78/78
100% Branches 3/3
100% Functions 1/1
100% Lines 78/78

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 793x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 3x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 36x 8x 8x 36x 36x 3x 3x 3x 3x 3x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
'use strict';
 
// MODULES //
 
var float64ToFloat32 = require( '@stdlib/number/float64/base/to-float32' );
var sumpw = require( './sumpw.js' );
 
 
// MAIN //
 
/**
* Computes the sum of single-precision floating-point strided array elements, ignoring `NaN` values and using pairwise summation.
*
* ## Method
*
* -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.
*
* ## References
*
* -   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).
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float32Array} x - input array
* @param {integer} strideX - stride length for `x`
* @param {NonNegativeInteger} offsetX - starting index for `x`
* @param {Float32Array} out - output array
* @param {integer} strideOut - stride length for `out`
* @param {NonNegativeInteger} offsetOut - starting index for `out`
* @returns {Float32Array} output array
*
* @example
* var Float32Array = require( '@stdlib/array/float32' );
*
* var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
* var out = new Float32Array( 2 );
*
* var v = snannsumpw( 5, x, 2, 1, out, 1, 0 );
* // returns <Float32Array>[ 5.0, 4 ]
*/
function snannsumpw( N, x, strideX, offsetX, out, strideOut, offsetOut ) {
	var io = offsetOut;
 
	// Initialize output values:
	out[ io ] = float64ToFloat32( -0.0 ); // note: initialize to negative zero to allow preservation of negative zero for the edge case of an input array containing only negative zeros
	out[ io+strideOut ] = float64ToFloat32( 0 );
 
	// Perform pairwise summation:
	sumpw( N, x, strideX, offsetX, out, strideOut, io );
 
	// If all elements were `NaN`, the default sum is positive zero...
	if ( out[ io+strideOut ] === 0 ) {
		out[ io ] = float64ToFloat32( 0.0 );
	}
	return out;
}
 
 
// EXPORTS //
 
module.exports = snannsumpw;