External module "stats/base/dists/t/mode/docs/types/index.d"

mode

• mode(v: number): number

• Returns the mode of a Student's t distribution.

  Notes

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

  Parameters

  • v: number

    degrees of freedom

  Returns number

  mode

  Example

  var v = mode( 9.0 );
  // returns 0.0

  Example

  var v = mode( 2.0 );
  // returns 0.0

  Example

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

  Example

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