@stdlib/blas-ext-base-dapxsumkbn/lib/index.js

Adds a constant to each double-precision floating-point strided array element and computes the sum using an improved Kahan–Babuška algorithm.

/**
* @license Apache-2.0
*
* Copyright (c) 2020 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';

/**
* Add a constant to each double-precision floating-point strided array element and compute the sum using an improved Kahan–Babuška algorithm.
*
* @module @stdlib/blas-ext-base-dapxsumkbn
*
* @example
* var Float64Array = require( '@stdlib/array-float64' );
* var dapxsumkbn = require( '@stdlib/blas-ext-base-dapxsumkbn' );
*
* var x = new Float64Array( [ 1.0, -2.0, 2.0 ] );
*
* var v = dapxsumkbn( 3, 5.0, x, 1 );
* // returns 16.0
*
* @example
* var Float64Array = require( '@stdlib/array-float64' );
* var dapxsumkbn = require( '@stdlib/blas-ext-base-dapxsumkbn' );
*
* var x = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
*
* var v = dapxsumkbn.ndarray( 4, 5.0, x, 2, 1 );
* // returns 25.0
*/

// MODULES //

var join = require( 'path' ).join;
var tryRequire = require( '@stdlib/utils-try-require' );
var isError = require( '@stdlib/assert-is-error' );
var main = require( './main.js' );


// MAIN //

var dapxsumkbn;
var tmp = tryRequire( join( __dirname, './native.js' ) );
if ( isError( tmp ) ) {
	dapxsumkbn = main;
} else {
	dapxsumkbn = tmp;
}


// EXPORTS //

module.exports = dapxsumkbn;

// exports: { "ndarray": "dapxsumkbn.ndarray" }