de.jstacs.models.mixture.gibbssampling
Interface GibbsSamplingComponent

All Known Subinterfaces:

GibbsSamplingFromStatistic, GibbsSamplingModel

All Known Implementing Classes:

FSDAGModelForGibbsSampling

public interface GibbsSamplingComponent

Method Summary

void	extendSampling(int sampling, boolean append) This method allows to extend a sampling.
void	initModelForSampling(int starts) This method initializes the model for the sampling.
boolean	isInSamplingMode() This method returns true if the object is currently used in a sampling, otherwise false.
boolean	parseNextParameterSet() This method allows the user to parse the next set of parameters (from a file).
boolean	parseParameterSet(int sampling, int n) This method allows the user to parse the set of parameters with index n of a certain sampling (from a file).
void	samplingStopped() This method is the opposite of the method extendSampling(int, boolean).

Method Detail

parseParameterSet

boolean parseParameterSet(int sampling,
                          int n)
                          throws Exception

This method allows the user to parse the set of parameters with index n of a certain sampling (from a file). The internal numbering should start with 0. The parameter set with index 0 is the initial (random) parameter set. It is recommended that a series of parameter sets is accessed by the following lines:

for( sampling = 0; sampling < numSampling; sampling++ )
{

boolean b = parseParameterSet( sampling, n );
while( b )
{
//do something
b = parseNextParameterSet();
} }


Parameters:

sampling - the index of the sampling

n - the index of the parameter set

Returns:

true if the parameter set could be parsed

Throws:

Exception - if there is a problem with parsing the parameters

See Also:

parseNextParameterSet()

parseNextParameterSet

boolean parseNextParameterSet()

This method allows the user to parse the next set of parameters (from a file).

Returns:

true if the parameters could be parsed, otherwise false

See Also:

parseParameterSet(int, int)

initModelForSampling

void initModelForSampling(int starts)
                          throws IOException

This method initializes the model for the sampling. For instance this method can be used to create new files where all parameter sets are stored.

Parameters:

starts - the number of different sampling starts that will be done

Throws:

IOException - if something went wrong

See Also:

File.createTempFile(String, String, java.io.File )

extendSampling

void extendSampling(int sampling,
                    boolean append)
                    throws IOException

This method allows to extend a sampling.

Parameters:

sampling - the index of the sampling

append - whether to append the sampled parameters to an existing file or to overwrite the file

Throws:

IOException - if the file could not be handled correctly

samplingStopped

void samplingStopped()
                     throws IOException

This method is the opposite of the method extendSampling(int, boolean). It can be used for closing any streams of writer, ...

Throws:

IOException - if something went wrong

See Also:

extendSampling(int, boolean)

isInSamplingMode

boolean isInSamplingMode()

This method returns true if the object is currently used in a sampling, otherwise false.

Returns:

true if the object is currently used in a sampling, otherwise false