com.mockturtlesolutions.snifflib.stats

Class HypergeometricDistribution

java.lang.Object

com.mockturtlesolutions.snifflib.stats.ProbabilityDensity

com.mockturtlesolutions.snifflib.stats.HypergeometricDistribution

All Implemented Interfaces:

NamedParameters, OptimizableScalar, CDF, InvCDF

public class HypergeometricDistribution
extends ProbabilityDensity

Field Summary

Fields inherited from class com.mockturtlesolutions.snifflib.stats.ProbabilityDensity

GET_CDF, GET_ICDF, GET_PDF

Constructor Summary

Constructors

Constructor and Description
HypergeometricDistribution()
HypergeometricDistribution(DblMatrix m, DblMatrix n, DblMatrix s)

Method Summary

Methods

Modifier and Type	Method and Description
DblMatrix	cdf(DblMatrix xx) CDF of the Hypergeometric distribution.
DblMatrix	cdf(int xx) CDF of the Hypergeometric distribution.
DblMatrix	criticalValue(DblMatrix cdfval) For an input value C returns x such that P(X<=x) = C.
DblMatrix	getVariable()
DblMatrix	hasSupport(DblMatrix X) Returns 1 if the density has the input value in its support set (domain) and 0 otherwise.
DblMatrix	mean() Returns the expected value of the distribution for the currently configured parameters.
DblMatrix	mode() Returns the mode of the distribution for the currently configured parameters.
DblMatrix	pdf(DblMatrix R) Returns the value of the density function at X.
DblMatrix	pdf(int r) Returns the value of the density function at X.
DblMatrix	random(int n) Return N random draws from this distribution.
void	setM(DblMatrix m)
void	setM(int m)
void	setN(DblMatrix m)
void	setN(int m)
void	setS(DblMatrix m)
void	setS(int m)
void	setVariable(DblMatrix ff)
DblMatrix	variance() Returns the expected value of the distribution for the currently configured parameters.

Methods inherited from class com.mockturtlesolutions.snifflib.stats.ProbabilityDensity

assumeProbability, getAssumedProbability, getName, getParam, getParams, getValueAt, getValueToGet, getValueToMinimize, getVariableValue, hasParameter, parameterSet, replaceParams, setName, setParam, setValueToGet, setVariableValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HypergeometricDistribution

public HypergeometricDistribution()

HypergeometricDistribution

public HypergeometricDistribution(DblMatrix m,
                          DblMatrix n,
                          DblMatrix s)

Method Detail

random

public DblMatrix random(int n)

Return N random draws from this distribution.

Overrides:

random in class ProbabilityDensity

setM

public void setM(int m)

setN

public void setN(int m)

setS

public void setS(int m)

setM

public void setM(DblMatrix m)

setN

public void setN(DblMatrix m)

setS

public void setS(DblMatrix m)

setVariable

public void setVariable(DblMatrix ff)

getVariable

public DblMatrix getVariable()

criticalValue

public DblMatrix criticalValue(DblMatrix cdfval)

For an input value C returns x such that P(X<=x) = C. This is the inverse CDF of the distribution.

Specified by:

criticalValue in interface InvCDF

Specified by:

criticalValue in class ProbabilityDensity

pdf

public DblMatrix pdf(int r)

Returns the value of the density function at X.

pdf

public DblMatrix pdf(DblMatrix R)

Returns the value of the density function at X.

Specified by:

pdf in class ProbabilityDensity

hasSupport

public DblMatrix hasSupport(DblMatrix X)

Description copied from class: ProbabilityDensity

Returns 1 if the density has the input value in its support set (domain) and 0 otherwise.

Specified by:

hasSupport in class ProbabilityDensity

mean

public DblMatrix mean()

Returns the expected value of the distribution for the currently configured parameters.

mode

public DblMatrix mode()

Returns the mode of the distribution for the currently configured parameters.

variance

public DblMatrix variance()

Returns the expected value of the distribution for the currently configured parameters.

cdf

public DblMatrix cdf(DblMatrix xx)

CDF of the Hypergeometric distribution.

Specified by:

cdf in interface CDF

Specified by:

cdf in class ProbabilityDensity

cdf

public DblMatrix cdf(int xx)

CDF of the Hypergeometric distribution.