Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "math/base/special/logit/docs/types/index.d"

Index

Functions

Functions

Export assignment logit

  • logit(p: number): number
  • Evaluates the logit function.

    Notes

    • Let p be the probability of some event. The logit function is defined as the logarithm of the odds p / (1-p).
    • If p < 0 or p > 1, the function returns NaN.

    Parameters

    • p: number

      input value

    Returns number

    function value

    Example

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

    Example

    var y = logit( 0.9 );
    // returns ~2.197

    Example

    var y = logit( -4.0 );
    // returns NaN

    Example

    var y = logit( 1.5 );
    // returns NaN

    Example

    var y = logit( NaN );
    // returns NaN