time-to-botec/squiggle/node_modules/@stdlib/math/base/special/factorialln

factorialln

Natural logarithm of the factorial function.

The natural logarithm of the factorial function may be expressed

The factorial function may be defined as the product

or according to the recurrence relation

Following the convention for an empty product, in all definitions,

The Gamma function extends the factorial function for non-integer values.

The factorial of a negative integer is not defined.

Evaluating the natural logarithm of factorial function is useful as the factorial function can overflow for large n. Thus, factorialln( n ) is generally preferred to ln( n! ).

Usage

var factorialln = require( '@stdlib/math/base/special/factorialln' );

factorialln( x )

Evaluates the natural logarithm of the factorial function. For input values other than negative integers, the function returns ln( x! ) = ln( Γ(x+1) ), where Γ is the Gamma function. For negative integers, the function returns NaN.

var v = factorialln( 3.0 );
// returns ~1.792

v = factorialln( 2.4 );
// returns ~1.092

v = factorialln( -1.0 );
// returns NaN

v = factorialln( -1.5 );
// returns ~1.266

If provided NaN, the function returns NaN.

var v = factorialln( NaN );
// returns NaN

Examples

var incrspace = require( '@stdlib/array/incrspace' );
var factorialln = require( '@stdlib/math/base/special/factorialln' );

var x;
var v;
var i;

x = incrspace( -10.0, 50.0, 0.5 );
for ( i = 0; i < x.length; i++ ) {
    v = factorialln( x[ i ] );
    console.log( 'x: %d, f(x): %d', x[ i ], v );
}