Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/dists/erlang/mean/docs/types/index.d"

Index

Functions

Functions

mean

  • mean(k: number, lambda: number): number
  • Returns the expected value of an Erlang distribution.

    Notes

    • If not provided a positive integer for k, the function returns NaN.
    • If provided a non-positive value for lambda, the function returns NaN.

    Parameters

    • k: number

      shape parameter

    • lambda: number

      rate parameter

    Returns number

    expected value

    Example

    var v = mean( 1, 1.0 );
    // returns 1.0

    Example

    var v = mean( 4, 12.0 );
    // returns ~0.333

    Example

    var v = mean( 8, 2.0 );
    // returns 4.0

    Example

    var v = mean( 1.5, 2.0 );
    // returns NaN

    Example

    var v = mean( 1, -0.1 );
    // returns NaN

    Example

    var v = mean( -0.1, 1.0 );
    // returns NaN

    Example

    var v = mean( 2, NaN );
    // returns NaN

    Example

    var v = mean( NaN, 2.0 );
    // returns NaN