time-to-botec

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

smeanpw.js (1506B)


      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 ssumpw = require( '@stdlib/blas/ext/base/ssumpw' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Computes the arithmetic mean of a single-precision floating-point strided array using pairwise summation.
     31 *
     32 * @param {PositiveInteger} N - number of indexed elements
     33 * @param {Float32Array} x - input array
     34 * @param {integer} stride - stride length
     35 * @returns {number} arithmetic mean
     36 *
     37 * @example
     38 * var Float32Array = require( '@stdlib/array/float32' );
     39 *
     40 * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] );
     41 * var N = x.length;
     42 *
     43 * var v = smeanpw( N, x, 1 );
     44 * // returns ~0.3333
     45 */
     46 function smeanpw( N, x, stride ) {
     47 	if ( N <= 0 ) {
     48 		return NaN;
     49 	}
     50 	if ( N === 1 || stride === 0 ) {
     51 		return x[ 0 ];
     52 	}
     53 	return float64ToFloat32( ssumpw( N, x, stride ) / N );
     54 }
     55 
     56 
     57 // EXPORTS //
     58 
     59 module.exports = smeanpw;