Package edu.cmu.tetrad.util.dist
Class Discrete
java.lang.Object
edu.cmu.tetrad.util.dist.Discrete
- All Implemented Interfaces:
Distribution
,TetradSerializable
,Serializable
Wraps a chi square distribution for purposes of drawing random samples. Methods are provided to allow parameters to
be manipulated in an interface. A value of n is returned if a number drawn uniformly from [0, 1] is less than the n +
1th p value.
- Author:
- josephramsey
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns the name of the distribution.int
Returns the number of parameters in the distribution.double
getParameter
(int index) Returns the index'th parameter.getParameterName
(int index) The name of the index'th parameter, for display purposes.double
Returns the next random number from the distribution.static Discrete
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.toString()
-
Method Details
-
serializableInstance
Generates a simple exemplar of this class to test serialization.- Returns:
- The exemplar.
-
getNumParameters
public int getNumParameters()Description copied from interface:Distribution
Returns the number of parameters in the distribution.- Specified by:
getNumParameters
in interfaceDistribution
- Returns:
- the number of parameters.
-
getName
Description copied from interface:Distribution
Returns the name of the distribution.- Specified by:
getName
in interfaceDistribution
- Returns:
- the name.
-
setParameter
public void setParameter(int index, double value) Description copied from interface:Distribution
Sets the index'th parameter to the given value.- Specified by:
setParameter
in interfaceDistribution
- Parameters:
index
- Ibid. Must be >= 0 and < # parameters.value
- Ibid.
-
getParameter
public double getParameter(int index) Description copied from interface:Distribution
Returns the index'th parameter.- Specified by:
getParameter
in interfaceDistribution
- Parameters:
index
- Ibid. Muist be <= 0 and < # parameters.- Returns:
- The Ibid.
-
getParameterName
Description copied from interface:Distribution
The name of the index'th parameter, for display purposes.- Specified by:
getParameterName
in interfaceDistribution
- Parameters:
index
- Ibid. Must be >= 0 and < # parameters.- Returns:
- Ibid.
-
nextRandom
public double nextRandom()Description copied from interface:Distribution
Returns the next random number from the distribution.- Specified by:
nextRandom
in interfaceDistribution
- Returns:
- Ibid.
-
toString
-