org.opt4j.core.optimizer
Interface Optimizer

All Known Implementing Classes:

AbstractOptimizer, OptimizationMediator

public interface Optimizer

This Optimizer interface has to be implemented by all population-based optimizers.

To implement an iteration-based Optimizers, use the simpler IterativeOptimizer interface.

To bind an Optimizer, use OptimizerModule.bindOptimizer(java.lang.Class).

Method Summary

void	addOptimizerIterationListener(OptimizerIterationListener listener) Adds an OptimizerIterationListener to this optimizer.
void	addOptimizerStateListener(OptimizerStateListener listener) Adds an OptimizerStateListener to this optimizer.
int	getIteration() Return the current iteration.
boolean	isRunning() Returns true if the Optimizer is running.
void	optimize() Starts the optimization process.
void	removeOptimizerIterationListener(OptimizerIterationListener listener) Removes an OptimizerIterationListener from this optimizer.
void	removeOptimizerStateListener(OptimizerStateListener listener) Removes an OptimizerStateListener from this optimizer.
void	startOptimization() This method is called to start the optimization process.
void	stopOptimization() This method is called once the optimization process has stopped.

Method Detail

optimize

void optimize()
              throws StopException,
                     TerminationException

Starts the optimization process.

Throws:

StopException - if the optimization is stopped

TerminationException - if the optimization is terminated

addOptimizerIterationListener

void addOptimizerIterationListener(OptimizerIterationListener listener)

Adds an OptimizerIterationListener to this optimizer.

Parameters:

listener - the OptimizerIterationListener to add

See Also:

removeOptimizerIterationListener(org.opt4j.core.optimizer.OptimizerIterationListener)

removeOptimizerIterationListener

void removeOptimizerIterationListener(OptimizerIterationListener listener)

Removes an OptimizerIterationListener from this optimizer.

Parameters:

listener - the OptimizerIterationListener to remove

See Also:

addOptimizerIterationListener(org.opt4j.core.optimizer.OptimizerIterationListener)

addOptimizerStateListener

void addOptimizerStateListener(OptimizerStateListener listener)

Adds an OptimizerStateListener to this optimizer.

Parameters:

listener - the OptimizerStateListener to add

See Also:

removeOptimizerStateListener(org.opt4j.core.optimizer.OptimizerStateListener)

removeOptimizerStateListener

void removeOptimizerStateListener(OptimizerStateListener listener)

Removes an OptimizerStateListener from this optimizer.

Parameters:

listener - the OptimizerStateListener to remove

See Also:

addOptimizerStateListener(org.opt4j.core.optimizer.OptimizerStateListener)

getIteration

int getIteration()

Return the current iteration.

Returns:

the current iteration

isRunning

boolean isRunning()

Returns true if the Optimizer is running.

Returns:

true if the optimizer is running

startOptimization

void startOptimization()

This method is called to start the optimization process.

stopOptimization

void stopOptimization()

This method is called once the optimization process has stopped.