broadwick.montecarlo

Class Poison

java.lang.Object

broadwick.montecarlo.Poison

All Implemented Interfaces:

MonteCarloResults

class Poison
extends Object
implements MonteCarloResults

Poison object that causes the consumer of the MonteCarlo results to stop looking for objects on the queue.

Constructor Summary

Constructors

Constructor and Description
Poison()

Method Summary

Modifier and Type	Method and Description
double	getExpectedValue() Get the score for the Monte Carlo simulation.
Samples	getSamples() Get the results of the Monte Carlo simulations as a Samples object.
MonteCarloResults	join(MonteCarloResults results) Join another Monte Carlo results object to this one.
void	reset() Clear the results of the MonteCarloResults object.
String	toCsv() Get a CSV string of the Monte Carlo results stored in this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

Poison

Poison()

Method Detail

getExpectedValue

public double getExpectedValue()

Description copied from interface: MonteCarloResults

Get the score for the Monte Carlo simulation. The Acceptor interface and it's implementing classes require a known value in this class for their analysis, e.g. this method may return the likelihood of the simulation and the Acceptor class (e.g. MetropolisHastingsAcceptor) will use the McResults.getExpectedValue() method to determine whether or not to accept this proposed step.

Specified by:

getExpectedValue in interface MonteCarloResults

Returns:

the value of the score.

getSamples

public Samples getSamples()

Description copied from interface: MonteCarloResults

Get the results of the Monte Carlo simulations as a Samples object.

Specified by:

getSamples in interface MonteCarloResults

Returns:

A samples object that contains the results of each Monte Carlo Simulation.

toCsv

public String toCsv()

Description copied from interface: MonteCarloResults

Get a CSV string of the Monte Carlo results stored in this class. This will be used for logging and for output to file and can contain statistics about the results e.g. the mean, std deviation etc. as appropriate.

Specified by:

toCsv in interface MonteCarloResults

Returns:

a CSV representation of the results.

join

public final MonteCarloResults join(MonteCarloResults results)

Description copied from interface: MonteCarloResults

Join another Monte Carlo results object to this one. When running a Monte Carlo simulation it is often necessary to append the results from a simulation to a 'master' results object.

Specified by:

join in interface MonteCarloResults

Parameters:

results - the results object to join.

Returns:

the new/updated results object.

reset

public void reset()

Description copied from interface: MonteCarloResults

Clear the results of the MonteCarloResults object. This will be called by several algorithms (e.g. MCMC) to clear any cached results that should be cleared between runs.

Specified by:

reset in interface MonteCarloResults