time-to-botec/squiggle/node_modules/@stdlib/math/base/special/logit/README.md

logit

Compute the logit function.

The logit function is defined as the logarithm of the odds p / (1-p); i.e.,

The logit function is the inverse of the standard logistic function, sometimes also called the sigmoid function.

Usage

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

logit( p )

Computes the logit function.

var v = logit( 0.2 );
// returns ~-1.386

v = logit( 0.9 );
// returns ~2.197

If p < 0 or p > 1, the function returns NaN.

var v = logit( 1.3 );
// returns NaN

v = logit( -0.2 );
// returns NaN

Examples

var randu = require( '@stdlib/random/base/randu' );
var logit = require( '@stdlib/math/base/special/logit' );

var p;
var i;

for ( i = 0; i < 100; i++ ) {
    p = randu();
    console.log( 'logit(%d) = %d', p, logit( p ) );
}