Package edu.cmu.tetrad.util.dist

Class ChiSquare

java.lang.Object

edu.cmu.tetrad.util.dist.ChiSquare

All Implemented Interfaces:

Distribution, TetradSerializable, Serializable

public class ChiSquare
extends Object
implements Distribution

Wraps a chi square distribution for purposes of drawing random samples. Methods are provided to allow parameters to be manipulated in an interface. See Wikipedia.

Version:

$Id: $Id

Author:

josephramsey

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
String	getName()	getName.
int	getNumParameters()	getNumParameters.
double	getParameter(int index)	Returns the index'th parameter.
String	getParameterName(int index)	Returns the name of the index'th parameter, for display purposes.
double	nextRandom()	nextRandom.
static ChiSquare	serializableInstance()	Generates a simple exemplar of this class to test serialization.
void	setParameter(int index, double value)	Sets the index'th parameter to the given value.
String	toString()	toString.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

serializableInstance

public static ChiSquare serializableInstance()

Generates a simple exemplar of this class to test serialization.

Returns:

the exemplar.

setParameter

public void setParameter(int index,
 double value)

Sets the index'th parameter to the given value.

Specified by:

setParameter in interface Distribution

Parameters:

index - The index of the parameter. Must be >= 0 and < # parameters.

value - The value to set for the parameter.

Throws:

IllegalArgumentException - If the index is invalid.

getParameter

public double getParameter(int index)

Returns the index'th parameter.

Specified by:

getParameter in interface Distribution

Parameters:

index - The index of the parameter. Must be >= 0 and < # parameters.

Returns:

The value of the parameter at the specified index.

Throws:

IllegalArgumentException - If the index is invalid.

getParameterName

public String getParameterName(int index)

Returns the name of the index'th parameter, for display purposes.

Specified by:

getParameterName in interface Distribution

Parameters:

index - The index of the parameter. Must be >= 0 and < # parameters.

Returns:

The name of the parameter at the specified index.

Throws:

IllegalArgumentException - If the index is invalid.

getNumParameters

public int getNumParameters()

getNumParameters.

Specified by:

getNumParameters in interface Distribution

Returns:

a int

getName

public String getName()

getName.

Specified by:

getName in interface Distribution

Returns:

a String object

nextRandom

public double nextRandom()

nextRandom.

Specified by:

nextRandom in interface Distribution

Returns:

a double

toString

public String toString()

toString.

Overrides:

toString in class Object

Returns:

a String object