@stdlib/math-base-special-logaddexp/lib/native.js

Compute the natural logarithm of exp(x) + exp(y).

/**
* @license Apache-2.0
*
* Copyright (c) 2024 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 addon = require( './../src/addon.node' );


// MAIN //

/**
* Computes the natural logarithm of `exp(x) + exp(y)`.
*
* @private
* @param {number} x - first number
* @param {number} y - second number
* @returns {number} natural logarithm of \\( \exp(x) + \exp(y) \\)
*
* @example
* var v = logaddexp( 90.0, 90.0 );
* // returns ~90.6931
*
* @example
* var v = logaddexp( -20.0, 90.0 );
* // returns 90.0
*
* @example
* var v = logaddexp( NaN, 1.0 );
* // returns NaN
*
* @example
* var v = logaddexp( 0.0, -100.0 );
* // returns ~3.7201e-44
*/
function logaddexp( x, y ) {
	return addon( x, y );
}


// EXPORTS //

module.exports = logaddexp;