All files main.js

100% Statements 78/78
100% Branches 7/7
100% Functions 1/1
100% Lines 78/78

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 791x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5127x 5127x 500x 500x 5127x 2503x 2503x 2124x 5127x 1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 isNegativeInteger = require( '@stdlib/math/base/assert/is-negative-integer' );
var gamma1pm1 = require( '@stdlib/math/base/special/gamma1pm1' );
var gammaln = require( '@stdlib/math/base/special/gammaln' );
var log1p = require( '@stdlib/math/base/special/log1p' );
 
 
// MAIN //
 
/**
* Evaluates the natural logarithm of the factorial of `x`.
*
* ## Method
*
* For \\(-1 < x < 2\\), forming \\(x+1\\) can round away low-order bits of \\(x\\), which results in large relative errors near the zeros of \\(\ln \Gamma(x+1)\\) at \\(x = 0\\) and \\(x = 1\\). To avoid forming \\(x+1\\), we use the identity
*
* ```tex
* \ln \Gamma(x+1) = \operatorname{log1p}(\Gamma(x+1) - 1) = \operatorname{log1p}(\operatorname{gamma1pm1}(x))
* ```
*
* @param {number} x - input value
* @returns {number} natural logarithm of factorial of `x`
*
* @example
* var v = factorialln( 3.0 );
* // returns ~1.792
*
* @example
* var v = factorialln( 2.4 );
* // returns ~1.092
*
* @example
* var v = factorialln( -1.0 );
* // returns NaN
*
* @example
* var v = factorialln( -1.5 );
* // returns ~1.266
*
* @example
* var v = factorialln( NaN );
* // returns NaN
*/
function factorialln( x ) {
	if ( isNegativeInteger( x ) ) {
		return NaN;
	}
	if ( x > -1.0 && x < 2.0 ) {
		return log1p( gamma1pm1( x ) );
	}
	return gammaln( x + 1.0 );
}
 
 
// EXPORTS //
 
module.exports = factorialln;