net.sourceforge.cilib.simulator

Class Simulator

java.lang.Object

net.sourceforge.cilib.simulator.Simulator

public class Simulator
extends java.lang.Object

This class represents an instance of a "simulator" that may or may not contain multiple individual simulations.

Each simulation experiment is repeated based on the number of samples that the measurement suite requires (although this is subject to change in a future version of the library). In this implementation each experiment is execute in its own thread. Thus, each experiment is execute in parallel for a given simulation.

The primary purpose of running simulations is to measure the performance of the given algorithm on a given problem. For that reason, a simulation accepts a measurement suite which it uses to record the performance.

Constructor Summary

Constructors

Constructor and Description
Simulator(XMLObjectFactory algorithmFactory, XMLObjectFactory problemFactory, XMLObjectFactory measurementFactory, MeasurementCombiner combiner, int samples, net.sourceforge.cilib.math.random.generator.seeder.SeedSelectionStrategy seeder) Creates a new instance of Simulator given an algorithm factory, a problem factory and a measurement suite.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgressListener(net.sourceforge.cilib.algorithm.ProgressListener listener) Adds a listener for progress events.
Simulation	createSimulation()
void	execute() Executes all the experiments for this simulation.
int	getSamples()
void	init() Perform the initialisation of the Simulator by creating the required Simulation instances and executing the threads.
void	removeProgressListener(net.sourceforge.cilib.algorithm.ProgressListener listener) Removes a listener for progress events.
void	terminate() Terminates all the experiments.

Methods inherited from class java.lang.Object

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

Constructor Detail

Simulator

public Simulator(XMLObjectFactory algorithmFactory,
         XMLObjectFactory problemFactory,
         XMLObjectFactory measurementFactory,
         MeasurementCombiner combiner,
         int samples,
         net.sourceforge.cilib.math.random.generator.seeder.SeedSelectionStrategy seeder)

Creates a new instance of Simulator given an algorithm factory, a problem factory and a measurement suite.

Parameters:

algorithmFactory - The algorithm factory.

problemFactory - The problem factory.

measurementFactory - The measurement suite.

See Also:

net.sourceforge.cilib.XMLObjectFactory

Method Detail

init

public void init()

Perform the initialisation of the Simulator by creating the required Simulation instances and executing the threads.

createSimulation

public Simulation createSimulation()

execute

public void execute()

Executes all the experiments for this simulation. The measurement suite will be closed once this method completes.

terminate

public void terminate()

Terminates all the experiments.

addProgressListener

public void addProgressListener(net.sourceforge.cilib.algorithm.ProgressListener listener)

Adds a listener for progress events. A progress is fired periodically based on the resolution of the measurements. ProgressEvent ProgressListener

Parameters:

listener - The event listener

removeProgressListener

public void removeProgressListener(net.sourceforge.cilib.algorithm.ProgressListener listener)

Removes a listener for progress events.

Parameters:

listener - The event listener

getSamples

public int getSamples()