Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "stats/base/dists/rayleigh/variance/docs/types/index.d"

Index

Functions

Functions

variance

  • variance(sigma: number): number
  • Returns the variance of a Rayleigh distribution.

    Notes

    • If provided σ < 0, the function returns NaN.

    Parameters

    • sigma: number

      scale parameter

    Returns number

    variance

    Example

    var v = variance( 9.0 );
    // returns ~34.765

    Example

    var v = variance( 2.0 );
    // returns ~1.717

    Example

    var v = variance( -0.2 );
    // returns NaN

    Example

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