time-to-botec

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

ndarray.native.js (2301B)


      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 Float64Array = require( '@stdlib/array/float64' );
     24 var addon = require( './dnannsumkbn.native.js' );
     25 
     26 
     27 // MAIN //
     28 
     29 /**
     30 * Computes the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
     31 *
     32 * @param {PositiveInteger} N - number of indexed elements
     33 * @param {Float64Array} x - input array
     34 * @param {integer} strideX - `x` stride length
     35 * @param {NonNegativeInteger} offsetX - `x` starting index
     36 * @param {Float64Array} out - output array
     37 * @param {integer} strideOut - `out` stride length
     38 * @param {NonNegativeInteger} offsetOut - `out` starting index
     39 * @returns {Float64Array} output array
     40 *
     41 * @example
     42 * var Float64Array = require( '@stdlib/array/float64' );
     43 * var floor = require( '@stdlib/math/base/special/floor' );
     44 *
     45 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
     46 * var out = new Float64Array( 2 );
     47 *
     48 * var N = floor( x.length / 2 );
     49 *
     50 * var v = dnannsumkbn( N, x, 2, 1, out, 1, 0 );
     51 * // returns <Float64Array>[ 5.0, 4 ]
     52 */
     53 function dnannsumkbn( N, x, strideX, offsetX, out, strideOut, offsetOut ) {
     54 	var viewOut;
     55 	var viewX;
     56 	if ( strideX < 0 ) {
     57 		offsetX += (N-1) * strideX;
     58 	}
     59 	if ( strideOut < 0 ) {
     60 		offsetOut += strideOut;
     61 	}
     62 	viewX = new Float64Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offsetX), x.length-offsetX ); // eslint-disable-line max-len
     63 	viewOut = new Float64Array( out.buffer, out.byteOffset+(out.BYTES_PER_ELEMENT*offsetOut), out.length-offsetOut ); // eslint-disable-line max-len
     64 	addon( N, viewX, strideX, viewOut, strideOut );
     65 	return out;
     66 }
     67 
     68 
     69 // EXPORTS //
     70 
     71 module.exports = dnannsumkbn;