de.jstacs
Interface InstantiableFromParameterSet

All Known Implementing Classes:

Alphabet, AlphabetContainer, BayesianNetworkModel, ComplementableDiscreteAlphabet, ContinuousAlphabet, DAGModel, DiscreteAlphabet, DiscreteGraphicalModel, DNAAlphabet, FSDAGModel, FSDAGModelForGibbsSampling, InhomogeneousDGM

public interface InstantiableFromParameterSet

Interface for all classes that can be instantiated from a ParameterSet. Each class ABC implementing this interface must provide a constructor of kind
ABC(ParameterSet parameters).

In order to provide a suitable ParameterSet to obtain all necessary values of these variables the user should implement a subclass of the abstract class ParameterSet or one of its subclasses, that creates the necessary Parameters in its loadParameters()-method.

Author:

Jan Grau, Jens Keilwagen

See Also:

ParameterSet

Method Summary

ParameterSet

getCurrentParameterSet() Returns the ParameterSet that has been used to instantiate the current instance of the implementing class.

Method Detail

getCurrentParameterSet

ParameterSet getCurrentParameterSet()
                                    throws Exception

Returns the ParameterSet that has been used to instantiate the current instance of the implementing class. If the current instance was not created using a ParameterSet, an equivalent ParameterSet should be returned, such that an instance created using this ParameterSet would be in principle equal to the current instance.

Returns:

the current ParameterSet

Throws:

Exception - is thrown if the ParameterSet could not be returned