time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/t/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

6.3 KiB

Student's T

Student's t distribution.

Usage

var t = require( '@stdlib/stats/base/dists/t' );

t

Student's t distribution.

var dist = t;
// returns {...}

The namespace contains the following distribution functions:

  • cdf( x, v ): Student's t distribution cumulative distribution function (CDF).
  • logcdf( x, v ): evaluate the natural logarithm of the cumulative distribution function (CDF) for a Student's t distribution.
  • logpdf( x, v ): evaluate the natural logarithm of the probability density function (PDF) for a Student's t distribution.
  • pdf( x, v ): Student's t distribution probability density function (PDF).
  • quantile( p, v ): Student's t distribution quantile function.

The namespace contains the following functions for calculating distribution properties:

The namespace contains a constructor function for creating a Student's t distribution object.

  • T( [v] ): Student's t distribution constructor.
var T = require( '@stdlib/stats/base/dists/t' ).T;

var dist = new T( 2.0 );

var y = dist.cdf( 0.5 );
// returns ~0.667

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var t = require( '@stdlib/stats/base/dists/t' );

console.log( objectKeys( t ) );