de.jstacs.sampling
Class VarianceRatioBurnInTestParameterSet
java.lang.Object
de.jstacs.parameters.ParameterSet
de.jstacs.parameters.InstanceParameterSet<AbstractBurnInTest>
de.jstacs.sampling.AbstractBurnInTestParameterSet
de.jstacs.sampling.VarianceRatioBurnInTestParameterSet
- All Implemented Interfaces:
- GalaxyConvertible, Storable, Cloneable
public class VarianceRatioBurnInTestParameterSet
- extends AbstractBurnInTestParameterSet
Class for the parameters of a VarianceRatioBurnInTest
. This
class fulfills the requirements of a AbstractBurnInTestParameterSet
and
can be used to create a new VarianceRatioBurnInTest
.
- Author:
- Jens Keilwagen
Methods inherited from class de.jstacs.parameters.ParameterSet |
fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy |
VarianceRatioBurnInTestParameterSet
public VarianceRatioBurnInTestParameterSet()
throws IllegalArgumentException
- Creates a new
VarianceRatioBurnInTestParameterSet
with empty parameter values.
- Throws:
IllegalArgumentException
- if instanceClass
is null
VarianceRatioBurnInTestParameterSet
public VarianceRatioBurnInTestParameterSet(int starts,
double t)
throws IllegalArgumentException,
SimpleParameter.IllegalValueException
- Creates a new
VarianceRatioBurnInTestParameterSet
with
pre-defined parameter values.
- Parameters:
starts
- the number of runs the Gibbs Sampler will be startedt
- the threshold for determining the end of the burn-in phase
- Throws:
IllegalArgumentException
- if instanceClass
is null
SimpleParameter.IllegalValueException
- if t
can not be set
VarianceRatioBurnInTestParameterSet
public VarianceRatioBurnInTestParameterSet(StringBuffer representation)
throws NonParsableException
- The standard constructor for the interface
Storable
.
Constructs an VarianceRatioBurnInTestParameterSet
out of an XML representation.
- Parameters:
representation
- the XML representation as StringBuffer
- Throws:
NonParsableException
- if the VarianceRatioBurnInTestParameterSet
could not be
reconstructed out of the StringBuffer
representation
getThreshold
public double getThreshold()
- Returns the threshold used in the
VarianceRatioBurnInTestParameterSet
.
- Returns:
- the threshold used in the
VarianceRatioBurnInTestParameterSet
getInstanceComment
public String getInstanceComment()
- Description copied from class:
InstanceParameterSet
- Returns a comment (a textual description) of the class that can be
constructed using this
ParameterSet
.
- Specified by:
getInstanceComment
in class InstanceParameterSet<AbstractBurnInTest>
- Returns:
- the comment of the class
getInstanceName
public String getInstanceName()
- Description copied from class:
InstanceParameterSet
- Returns the name of an instance of the class that can be constructed
using this
ParameterSet
.
- Specified by:
getInstanceName
in class InstanceParameterSet<AbstractBurnInTest>
- Returns:
- the name of the class