time-to-botec

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

index.js (1953B)

      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 /**
     22 * Compute the sum of double-precision floating-point strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
     23 *
     24 * @module @stdlib/blas/ext/base/dnannsumkbn2
     25 *
     26 * @example
     27 * var Float64Array = require( '@stdlib/array/float64' );
     28 * var dnannsumkbn2 = require( '@stdlib/blas/ext/base/dnannsumkbn2' );
     29 *
     30 * var x = new Float64Array( [ 1.0, -2.0, NaN, 2.0 ] );
     31 * var out = new Float64Array( 2 );
     32 *
     33 * var v = dnannsumkbn2( x.length, x, 1, out, 1 );
     34 * // returns <Float64Array>[ 1.0, 3 ]
     35 *
     36 * @example
     37 * var Float64Array = require( '@stdlib/array/float64' );
     38 * var floor = require( '@stdlib/math/base/special/floor' );
     39 * var dnannsumkbn2 = require( '@stdlib/blas/ext/base/dnannsumkbn2' );
     40 *
     41 * var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ] );
     42 * var out = new Float64Array( 2 );
     43 *
     44 * var N = floor( x.length / 2 );
     45 *
     46 * var v = dnannsumkbn2.ndarray( N, x, 2, 1, out, 1, 0 );
     47 * // returns <Float64Array>[ 5.0, 4 ]
     48 */
     49 
     50 // MODULES //
     51 
     52 var join = require( 'path' ).join;
     53 var tryRequire = require( '@stdlib/utils/try-require' );
     54 var dnannsumkbn2 = require( './main.js' );
     55 
     56 
     57 // MAIN //
     58 
     59 var tmp = tryRequire( join( __dirname, './native.js' ) );
     60 if ( !(tmp instanceof Error) ) {
     61 	dnannsumkbn2 = tmp;
     62 }
     63 
     64 
     65 // EXPORTS //
     66 
     67 module.exports = dnannsumkbn2;