de.jstacs.sequenceScores.statisticalModels.differentiable.directedGraphicalModels.structureLearning.measures
Class InhomogeneousMarkov.InhomogeneousMarkovParameterSet

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.parameters.InstanceParameterSet<Measure>
          de.jstacs.sequenceScores.statisticalModels.differentiable.directedGraphicalModels.structureLearning.measures.Measure.MeasureParameterSet
              de.jstacs.sequenceScores.statisticalModels.differentiable.directedGraphicalModels.structureLearning.measures.InhomogeneousMarkov.InhomogeneousMarkovParameterSet

All Implemented Interfaces:

GalaxyConvertible, Storable, Cloneable

Enclosing class:

InhomogeneousMarkov

public static class InhomogeneousMarkov.InhomogeneousMarkovParameterSet
extends Measure.MeasureParameterSet

Class for an InstanceParameterSet that defines the parameters of an InhomogeneousMarkov structure Measure.

Author:

Jan Grau

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet

errorMessage, parameters, parent

Constructor Summary

InhomogeneousMarkov.InhomogeneousMarkovParameterSet()
Creates a new InhomogeneousMarkov.InhomogeneousMarkovParameterSet with empty parameter values.

InhomogeneousMarkov.InhomogeneousMarkovParameterSet(int order)
Creates a new InhomogeneousMarkov.InhomogeneousMarkovParameterSet with the parameter for the order set to order.

InhomogeneousMarkov.InhomogeneousMarkovParameterSet(StringBuffer representation)
Creates a new InhomogeneousMarkov.InhomogeneousMarkovParameterSet from its XML representation as defined by the Storable interface.

Method Summary

String	getInstanceComment() Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.
String	getInstanceName() Returns the name of an instance of the class that can be constructed using this ParameterSet.
int	getOrder() Returns the order of the InhomogeneousMarkov structure measure as defined by this set of parameters.

Methods inherited from class de.jstacs.parameters.InstanceParameterSet

fromXML, getInstance, getInstanceClass, toXML

Methods inherited from class de.jstacs.parameters.ParameterSet

clone, fromGalaxy, getAllParameterNames, getComment, getComment, getErrorMessage, getIndex, getName, getName, getNumberOfParameters, getParameterAt, getParameterForName, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isComparable, parametersLoaded, reset, setParent, toGalaxy

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InhomogeneousMarkov.InhomogeneousMarkovParameterSet

public InhomogeneousMarkov.InhomogeneousMarkovParameterSet()

Creates a new InhomogeneousMarkov.InhomogeneousMarkovParameterSet with empty parameter values.

InhomogeneousMarkov.InhomogeneousMarkovParameterSet

public InhomogeneousMarkov.InhomogeneousMarkovParameterSet(int order)
                                                    throws SimpleParameter.IllegalValueException

Creates a new InhomogeneousMarkov.InhomogeneousMarkovParameterSet with the parameter for the order set to order.

Parameters:

order - the order

Throws:

SimpleParameter.IllegalValueException - if the value of the order is not allowed

InhomogeneousMarkov.InhomogeneousMarkovParameterSet

public InhomogeneousMarkov.InhomogeneousMarkovParameterSet(StringBuffer representation)
                                                    throws NonParsableException

Creates a new InhomogeneousMarkov.InhomogeneousMarkovParameterSet from its XML representation as defined by the Storable interface.

Parameters:

representation - the XML code as StringBuffer

Throws:

NonParsableException - if the XML representation could not be parsed

Method Detail

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<Measure>

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<Measure>

Returns:

the name of the class

getOrder

public int getOrder()

Returns the order of the InhomogeneousMarkov structure measure as defined by this set of parameters.

Returns:

the order