xal.extension.solver.algorithm

Class SearchAlgorithm

java.lang.Object

xal.extension.solver.algorithm.SearchAlgorithm

All Implemented Interfaces:

AlgorithmScheduleListener, SolutionJudgeListener

Direct Known Subclasses:

DirectedStep, InitialAlgorithm, RandomSearch, RandomShrinkSearch, SimplexSearchAlgorithm

public abstract class SearchAlgorithm
extends java.lang.Object
implements AlgorithmScheduleListener, SolutionJudgeListener

Abstract super class for an optimization search algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchAlgorithmListener	_eventProxy the proxy for forwarding messages to registered listeners
protected MessageCenter	_messageCenter the message center for dispatching messages
protected Problem	_problem the problem to solve

Constructor Summary

Constructors

Constructor and Description
SearchAlgorithm() Empty constructor.

Method Summary

Modifier and Type	Method and Description
void	addSearchAlgorithmListener(SearchAlgorithmListener listener) Add a search algorithm listener.
void	foundNewOptimalSolution(SolutionJudge source, java.util.List<Trial> solutions, Trial solution) Send a message that a new optimal solution has been found.
abstract java.lang.String	getLabel() Get the label for this search algorithm.
int	getMaxEvaluationsPerRun() Get the maximum number of evaluations per run.
int	getMinEvaluationsPerRun() Get the minimum number of evaluations per run.
abstract void	performRun(AlgorithmRun algorithmRun) Calculate the next few trial points.
void	removeSearchAlgorithmListener(SearchAlgorithmListener listener) Remove a search algorithm listener.
void	reset() Reset this algorithm.
void	setProblem(Problem problem) Assign a new problem.
void	strategyExecuted(AlgorithmSchedule schedule, AlgorithmStrategy strategy, ScoreBoard scoreBoard) Handle an event where a new algorithm run stack has completed.
void	strategyWillExecute(AlgorithmSchedule schedule, AlgorithmStrategy strategy, ScoreBoard scoreBoard) Handle an event where a new algorithm run stack will start.
void	trialScored(AlgorithmSchedule schedule, Trial trial) Handle a message that a trial has been scored.
void	trialVetoed(AlgorithmSchedule schedule, Trial trial) Handle a message that a trial has been vetoed.

Methods inherited from class java.lang.Object

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

Field Detail

_problem

protected Problem _problem

the problem to solve

_messageCenter

protected MessageCenter _messageCenter

the message center for dispatching messages

_eventProxy

protected SearchAlgorithmListener _eventProxy

the proxy for forwarding messages to registered listeners

Constructor Detail

SearchAlgorithm

public SearchAlgorithm()

Empty constructor.

Method Detail

setProblem

public void setProblem(Problem problem)

Assign a new problem.

reset

public void reset()

Reset this algorithm.

addSearchAlgorithmListener

public void addSearchAlgorithmListener(SearchAlgorithmListener listener)

Add a search algorithm listener.

Parameters:

listener - The listener to add.

removeSearchAlgorithmListener

public void removeSearchAlgorithmListener(SearchAlgorithmListener listener)

Remove a search algorithm listener.

Parameters:

listener - The listener to remove.

getLabel

public abstract java.lang.String getLabel()

Get the label for this search algorithm.

Returns:

The label for this algorithm

performRun

public abstract void performRun(AlgorithmRun algorithmRun)

Calculate the next few trial points.

Parameters:

algorithmRun - the algorithm run to perform the evaluation

getMinEvaluationsPerRun

public int getMinEvaluationsPerRun()

Get the minimum number of evaluations per run. Subclasses may want to override this method.

Returns:

the minimum number of evaluation per run.

getMaxEvaluationsPerRun

public int getMaxEvaluationsPerRun()

Get the maximum number of evaluations per run. Subclasses may want to override this method.

Returns:

the maximum number of evaluation per run.

trialScored

public void trialScored(AlgorithmSchedule schedule,
                        Trial trial)

Handle a message that a trial has been scored.

Specified by:

trialScored in interface AlgorithmScheduleListener

Parameters:

schedule - Description of the Parameter

trial - Description of the Parameter

trialVetoed

public void trialVetoed(AlgorithmSchedule schedule,
                        Trial trial)

Handle a message that a trial has been vetoed.

Specified by:

trialVetoed in interface AlgorithmScheduleListener

Parameters:

schedule - Description of the Parameter

trial - Description of the Parameter

strategyWillExecute

public void strategyWillExecute(AlgorithmSchedule schedule,
                                AlgorithmStrategy strategy,
                                ScoreBoard scoreBoard)

Handle an event where a new algorithm run stack will start.

Specified by:

strategyWillExecute in interface AlgorithmScheduleListener

Parameters:

schedule - the schedule posting the event

strategy - the strategy which will execute

scoreBoard - the scoreboard

strategyExecuted

public void strategyExecuted(AlgorithmSchedule schedule,
                             AlgorithmStrategy strategy,
                             ScoreBoard scoreBoard)

Handle an event where a new algorithm run stack has completed.

Specified by:

strategyExecuted in interface AlgorithmScheduleListener

Parameters:

schedule - the schedule posting the event

strategy - the strategy that has executed

scoreBoard - the scoreboard

foundNewOptimalSolution

public void foundNewOptimalSolution(SolutionJudge source,
                                    java.util.List<Trial> solutions,
                                    Trial solution)

Send a message that a new optimal solution has been found.

Specified by:

foundNewOptimalSolution in interface SolutionJudgeListener

Parameters:

source - The source of the new optimal solution.

solutions - The list of solutions.

solution - The new optimal solution.