de.jstacs.models.discrete.inhomogeneous.parameters
Class IDGMParameterSet

java.lang.Object
  extended by de.jstacs.parameters.ParameterSet
      extended by de.jstacs.parameters.InstanceParameterSet
          extended by de.jstacs.models.discrete.DGMParameterSet
              extended by de.jstacs.models.discrete.inhomogeneous.parameters.IDGMParameterSet
All Implemented Interfaces:
RangeIterator, Storable, Cloneable
Direct Known Subclasses:
BayesianNetworkModelParameterSet, FSDAGMParameterSet

public abstract class IDGMParameterSet
extends DGMParameterSet

This is the abstract container of parameters that is root container for all inhomogeneous discrete graphical model parameter containers.

Author:
Jens Keilwagen

Nested Class Summary
 
Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet
ParameterSet.ParameterList
 
Field Summary
 
Fields inherited from class de.jstacs.parameters.InstanceParameterSet
alphabet, length
 
Fields inherited from class de.jstacs.parameters.ParameterSet
alternativeInstanceClass, errorMessage, parameters, parent, ranged
 
Constructor Summary
protected IDGMParameterSet(Class<? extends InhomogeneousDGM> instanceClass)
          This constructor creates an empty parameter set instance for the specified class.
protected IDGMParameterSet(Class<? extends InhomogeneousDGM> instanceClass, AlphabetContainer alphabet, int length, double ess, String description)
          This constructor creates a parameter set instance for the specified class.
protected IDGMParameterSet(StringBuffer s)
          The constructor for the Storable interface.
 
Method Summary
static String getModelInstanceName(StructureLearner.ModelType model, byte order, StructureLearner.LearningType method, double ess)
          This method returns a short textual representation of the model instance.
 
Methods inherited from class de.jstacs.models.discrete.DGMParameterSet
clone, getInstanceName, hasDefaultOrIsSet, loadParameters, setEss
 
Methods inherited from class de.jstacs.parameters.InstanceParameterSet
equals, fromXML, getAlphabet, getIndex, getLength, getNumberOfParameters, getParameterAt, replaceParametersWithRangedInstance, reset, toXML
 
Methods inherited from class de.jstacs.parameters.ParameterSet
getErrorMessage, getId, getInstance, getInstanceClass, getInstanceComment, getNumberOfValues, getParent, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, resetToFirst, setAlternativeInstanceClass, setParent, simplify, valuesToString
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IDGMParameterSet

protected IDGMParameterSet(StringBuffer s)
                    throws NonParsableException
The constructor for the Storable interface.

Parameters:
s - the StringBuffer
Throws:
NonParsableException - if the StringBuffer is not parsable

IDGMParameterSet

protected IDGMParameterSet(Class<? extends InhomogeneousDGM> instanceClass)
This constructor creates an empty parameter set instance for the specified class.

Parameters:
instanceClass - the instance class

IDGMParameterSet

protected IDGMParameterSet(Class<? extends InhomogeneousDGM> instanceClass,
                           AlphabetContainer alphabet,
                           int length,
                           double ess,
                           String description)
                    throws Exception
This constructor creates a parameter set instance for the specified class. It sets the AlphabetContainer, the length, the ess and the model description.

Parameters:
instanceClass - the instance class
alphabet - the AlphabetContainer for the model
length - the length of the model
ess - the ess of the model
description - the model description
Throws:
Exception - if something went wrong
Method Detail

getModelInstanceName

public static String getModelInstanceName(StructureLearner.ModelType model,
                                          byte order,
                                          StructureLearner.LearningType method,
                                          double ess)
This method returns a short textual representation of the model instance.

Parameters:
model - the model type
order - the model order
method - the learning method
ess - the used ess
Returns:
a short textual representation of the model instance