de.jstacs.sampling
Class AbstractBurnInTestParameterSet
java.lang.Object
de.jstacs.parameters.ParameterSet
de.jstacs.parameters.InstanceParameterSet<AbstractBurnInTest>
de.jstacs.sampling.AbstractBurnInTestParameterSet
- All Implemented Interfaces:
- GalaxyConvertible, Storable, Cloneable
- Direct Known Subclasses:
- VarianceRatioBurnInTestParameterSet
public abstract class AbstractBurnInTestParameterSet
- extends InstanceParameterSet<AbstractBurnInTest>
Class for the parameters of a AbstractBurnInTest
. This
class fulfills the requirements of a InstanceParameterSet
and
can be used to create a new AbstractBurnInTest
.
- 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 |
AbstractBurnInTestParameterSet
protected AbstractBurnInTestParameterSet(Class<? extends AbstractBurnInTest> instanceClass)
throws IllegalArgumentException
- Creates a new
AbstractBurnInTestParameterSet
with empty parameter values.
- Parameters:
instanceClass
- the class to be instantiated
- Throws:
IllegalArgumentException
- if instanceClass
is null
AbstractBurnInTestParameterSet
protected AbstractBurnInTestParameterSet(Class<? extends AbstractBurnInTest> instanceClass,
int starts)
throws IllegalArgumentException,
SimpleParameter.IllegalValueException
- Creates a new
AbstractBurnInTestParameterSet
with
pre-defined parameter values.
- Parameters:
instanceClass
- the class to be instantiatedstarts
- the number of runs the Gibbs Sampler will be started
- Throws:
IllegalArgumentException
- if instanceClass
is null
SimpleParameter.IllegalValueException
- if starts
can not be set
AbstractBurnInTestParameterSet
protected AbstractBurnInTestParameterSet(StringBuffer representation)
throws NonParsableException
- The standard constructor for the interface
Storable
.
Constructs an AbstractBurnInTestParameterSet
out of an XML representation.
- Parameters:
representation
- the XML representation as StringBuffer
- Throws:
NonParsableException
- if the AbstractBurnInTestParameterSet
could not be
reconstructed out of the StringBuffer
representation
getNumberOfStarts
public int getNumberOfStarts()
- Returns the number of starts.
- Returns:
- the number of starts
clone
public AbstractBurnInTestParameterSet clone()
throws CloneNotSupportedException
- Description copied from class:
ParameterSet
- Creates a full clone (deep copy) of this
ParameterSet
. As a
convenience-method the user can use
fillWithStandardFieldsForClone(ParameterSet)
on a newly
created instance of a subclass of ParameterSet
to obtain a
clone/copy of all standard member variables (those already defined in
ParameterSet
) in the passed ParameterSet
. Using this
method, the cloning process becomes merely three-step:
- Create a new instance of your subclass of
ParameterSet
, most
likely with an empty constructor or the one taking just the instance
class.
- Call
this.fillWithStandardFieldsForClone
on this
instance.
- Return the instance.
This method fulfills the conventions of Object
's method
Object.clone()
.
- Overrides:
clone
in class ParameterSet
- Returns:
- a deep clone/copy of this
ParameterSet
- Throws:
CloneNotSupportedException