xal.extension.solver

Class AlgorithmPool

java.lang.Object

xal.extension.solver.AlgorithmPool

All Implemented Interfaces:

SearchAlgorithmListener, AlgorithmScheduleListener, SolutionJudgeListener

public class AlgorithmPool
extends java.lang.Object
implements SearchAlgorithmListener, SolutionJudgeListener, AlgorithmScheduleListener

AlgorithmPool keeps track of the available algorithms.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Collection<SearchAlgorithm>	_algorithms The list of all algorithms
protected java.util.Collection<SearchAlgorithm>	_availableAlgorithms The list of algorithms available for scheduling
protected MessageCenter	_messageCenter Message center for dispatching events to registerd listeners
protected AlgorithmPoolListener	_proxy Proxy which forwards events to registered listeners

Constructor Summary

Constructors

Constructor and Description
AlgorithmPool() Empty constructor which populates the pool of all algorithms
AlgorithmPool(java.util.Collection<SearchAlgorithm> algorithms) Creates a new AlgorithmPool instance Constructor that takes a list of algorithms
AlgorithmPool(SearchAlgorithm algorithm) Creates a new AlgorithmPool instance Constructor that takes a list of algorithms

Method Summary

Modifier and Type	Method and Description
void	addAlgorithm(SearchAlgorithm algorithm) Add an algorithm to the pool.
void	addAlgorithmPoolListener(AlgorithmPoolListener listener) Add an algorithm pool listener.
void	addAlgorithms(java.util.Collection<SearchAlgorithm> algorithms) Add existing algorithms to the algorithm list.
void	algorithmAvailable(SearchAlgorithm source) Send a message that an algorithm is available.
void	algorithmUnavailable(SearchAlgorithm source) Send a message that an algorithm is not available.
void	foundNewOptimalSolution(SolutionJudge source, java.util.List<Trial> solutions, Trial solution) Event indicating that a new optimal solution has been found.
static java.util.Collection<SearchAlgorithm>	generateDefaultAlgorithms() Get all the algorithms.
java.util.Collection<SearchAlgorithm>	getAlgorithms() Get the algorithm list.
java.util.Collection<SearchAlgorithm>	getAvailableAlgorithms() Get the available algorithms.
void	removeAlgorithm(SearchAlgorithm algorithm) Remove an algorithm from the pool.
void	removeAlgorithmPoolListener(AlgorithmPoolListener listener) Remove a algorithm pool listener.
void	removeAlgorithms(java.util.Collection<SearchAlgorithm> algorithms) Remove the specified algorithms.
void	removeAllAlgorithms() Remove all algorithms.
void	reset() Reset the algorithm pool by resetting all the algorithms.
void	setAlgorithm(SearchAlgorithm algorithm) Set the algorithm as the sole algorithm in the pool.
void	setProblem(Problem problem) Assign the problem to each algorithm in the pool.
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 algorithmSchedule, Trial trial) Send a message that a trial has been scored.
void	trialVetoed(AlgorithmSchedule algorithmSchedule, Trial trial) Send 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

_algorithms

protected java.util.Collection<SearchAlgorithm> _algorithms

The list of all algorithms

_availableAlgorithms

protected java.util.Collection<SearchAlgorithm> _availableAlgorithms

The list of algorithms available for scheduling

_messageCenter

protected MessageCenter _messageCenter

Message center for dispatching events to registerd listeners

_proxy

protected AlgorithmPoolListener _proxy

Proxy which forwards events to registered listeners

Constructor Detail

AlgorithmPool

public AlgorithmPool(java.util.Collection<SearchAlgorithm> algorithms)

Creates a new AlgorithmPool instance Constructor that takes a list of algorithms

Parameters:

algorithms - the collection of algorithms to populate the pool

AlgorithmPool

public AlgorithmPool()

Empty constructor which populates the pool of all algorithms

AlgorithmPool

public AlgorithmPool(SearchAlgorithm algorithm)

Creates a new AlgorithmPool instance Constructor that takes a list of algorithms

Parameters:

algorithm - Description of the Parameter

Method Detail

generateDefaultAlgorithms

public static java.util.Collection<SearchAlgorithm> generateDefaultAlgorithms()

Get all the algorithms.

Returns:

The default set of algorithms

reset

public void reset()

Reset the algorithm pool by resetting all the algorithms.

setProblem

public void setProblem(Problem problem)

Assign the problem to each algorithm in the pool.

Parameters:

problem - the problem to solve

addAlgorithmPoolListener

public void addAlgorithmPoolListener(AlgorithmPoolListener listener)

Add an algorithm pool listener.

Parameters:

listener - The listerner to add.

removeAlgorithmPoolListener

public void removeAlgorithmPoolListener(AlgorithmPoolListener listener)

Remove a algorithm pool listener.

Parameters:

listener - The listener to remove.

setAlgorithm

public void setAlgorithm(SearchAlgorithm algorithm)

Set the algorithm as the sole algorithm in the pool.

Parameters:

algorithm - the algorithm to set as the only item in the pool

addAlgorithms

public void addAlgorithms(java.util.Collection<SearchAlgorithm> algorithms)

Add existing algorithms to the algorithm list.

Parameters:

algorithms - The feature to be added to the Algorithms attribute

addAlgorithm

public void addAlgorithm(SearchAlgorithm algorithm)

Add an algorithm to the pool.

Parameters:

algorithm - The feature to be added to the Algorithm attribute

removeAlgorithm

public void removeAlgorithm(SearchAlgorithm algorithm)

Remove an algorithm from the pool.

Parameters:

algorithm - the algorithm to remove from the pool

removeAlgorithms

public void removeAlgorithms(java.util.Collection<SearchAlgorithm> algorithms)

Remove the specified algorithms.

Parameters:

algorithms - the algorithms to remove

removeAllAlgorithms

public void removeAllAlgorithms()

Remove all algorithms.

getAlgorithms

public java.util.Collection<SearchAlgorithm> getAlgorithms()

Get the algorithm list.

Returns:

The list of algorithms.

getAvailableAlgorithms

public java.util.Collection<SearchAlgorithm> getAvailableAlgorithms()

Get the available algorithms.

Returns:

The list of available algorithm.

trialScored

public void trialScored(AlgorithmSchedule algorithmSchedule,
                        Trial trial)

Send a message that a trial has been scored.

Specified by:

trialScored in interface AlgorithmScheduleListener

Parameters:

algorithmSchedule - The algorithm schedule that holds the trial scored.

trial - The trial that was scored.

trialVetoed

public void trialVetoed(AlgorithmSchedule algorithmSchedule,
                        Trial trial)

Send a message that a trial has been vetoed.

Specified by:

trialVetoed in interface AlgorithmScheduleListener

Parameters:

algorithmSchedule - The algorithm schedule that holds the trial vetoed.

trial - The trial that was vetoed.

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

algorithmAvailable

public void algorithmAvailable(SearchAlgorithm source)

Send a message that an algorithm is available. An algorithm is available if it has all the data it needs to propose a new trial.

Specified by:

algorithmAvailable in interface SearchAlgorithmListener

Parameters:

source - The source of the available algorithm.

algorithmUnavailable

public void algorithmUnavailable(SearchAlgorithm source)

Send a message that an algorithm is not available.

Specified by:

algorithmUnavailable in interface SearchAlgorithmListener

Parameters:

source - The source of the available algorithm.

foundNewOptimalSolution

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

Event indicating 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.