ESDoc Home Reference Source Repository

import StudentsT from 'sampson/lib/distributions/students.js'

public class | source

StudentsT

Extends:

Distribution → StudentsT

The Student's t-Distribution is a continuous probability distribution with parameters df = degrees of freedom*. See: Student's t-Distribution

Static Method Summary

Static Public Methods
public static	cdf(t: number, params: Object): number Calculate the probability of getting x or less StudentsT(df).
public static	kurtosis(params: Object): number Get the kurtosis of StudentsT(df).
public static	mean(params: Object): number Get the mean of StudentsT(df).
public static	pdf(t: number, params: Object): number Calculate the probability of exaclty x in StudentsT(df).
public static	random(params: Object): number Generate a random value from StudentsT(df).
public static	relStdDev(params: Object): number Get the relative standard deviation of StudentsT(df).
public static	skewness(params: Object): number Get the skewness of StudentsT(df).
public static	stdDev(params: Object): number Get the standard deviation of StudentsT(df).
public static	variance(params: Object): number Get the variance of StudentsT(df).

Inherited Summary

From class Distribution
public static	random(): number Generate a uniform random variable.
public static	sample(k: number, params: Object): Array<number> Generate an array of k random values.
public	kurtosis: number The distribution kurtosis.
public	mean: number The distribution mean.
public	params: Object The valitated distribution parameters.
public	relStdDev: number The distribution relative standard deviation.
public	skewness: number The distribution skewness.
public	stdDev: number The distribution standard deviation.
public	variance: number The distribution variance.
public	cdf(x: number): number Calculate the probability of getting x or less.
public	pdf(x: number): number Calculate the probability of exaclty x.
public	random(): number Generate a random value.
public	sample(n: number): Array<number> Generate an array of n random values.

Static Public Methods

public static cdf(t: number, params: Object): number source

Calculate the probability of getting x or less StudentsT(df).

Override:

Distribution#cdf

Params:

Name	Type	Attribute	Description
t	number		The value to predict.
params	Object		The distribution parameters.

Return:

The probability of getting x or less from StudentsT(df).

public static kurtosis(params: Object): number source

Get the kurtosis of StudentsT(df).

Override:

Distribution#kurtosis

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The kurtosis of StudentsT(df).

public static mean(params: Object): number source

Get the mean of StudentsT(df).

Override:

Distribution#mean

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The mean of StudentsT(df).

public static pdf(t: number, params: Object): number source

Calculate the probability of exaclty x in StudentsT(df).

Override:

Distribution#pdf

Params:

Name	Type	Attribute	Description
t	number		The value to predict.
params	Object		The distribution parameters.

Return:

The probability of x happening in StudentsT(df).

public static random(params: Object): number source

Generate a random value from StudentsT(df).

Override:

Distribution#random

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The random value from StudentsT(df).

public static relStdDev(params: Object): number source

Get the relative standard deviation of StudentsT(df).

Override:

Distribution#relStdDev

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The relative standard deviation of StudentsT(df).

public static skewness(params: Object): number source

Get the skewness of StudentsT(df).

Override:

Distribution#skewness

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The skewness of StudentsT(df).

public static stdDev(params: Object): number source

Get the standard deviation of StudentsT(df).

Override:

Distribution#stdDev

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The standard deviation of StudentsT(df).

public static variance(params: Object): number source

Get the variance of StudentsT(df).

Override:

Distribution#variance

Params:

Name	Type	Attribute	Description
params	Object		The distribution parameters.

Return:

The variance of StudentsT(df).