xal.extension.solver.market

Class AlgorithmMarket

java.lang.Object

xal.extension.solver.market.AlgorithmMarket

All Implemented Interfaces:

AlgorithmScheduleListener, SolutionJudgeListener

public class AlgorithmMarket
extends java.lang.Object
implements AlgorithmScheduleListener, SolutionJudgeListener

AlgorithmMarket keeps track of algorithm strategies.

Field Summary

Fields

Modifier and Type	Field and Description
protected AlgorithmPool	_algorithmPool the pool of algorithms from which to pick an algorithm
protected AlgorithmMarketListener	_eventProxy proxy which forwards events to registered listeners
protected MessageCenter	_messageCenter message center which dispatches events to registered listeners
protected java.util.List<AlgorithmStrategy>	_strategies the list of strategies in the market sorted by efficiency so the most efficient strategies appear first

Constructor Summary

Constructors

Constructor and Description
AlgorithmMarket() Constructor using the default algorithm pool and the default strategies.
AlgorithmMarket(AlgorithmPool pool) Constructor
AlgorithmMarket(AlgorithmPool pool, AlgorithmStrategy strategy) Constructor
AlgorithmMarket(AlgorithmPool pool, java.util.List<AlgorithmStrategy> strategies) Primary Constructor
AlgorithmMarket(java.util.List<AlgorithmStrategy> strategies) Constructor
AlgorithmMarket(SearchAlgorithm algorithm) Constructor

Method Summary

Modifier and Type	Method and Description
void	addAlgorithmMarketListener(AlgorithmMarketListener listener) Add a listener to receive AlgorithmMarket events.
void	addAlgorithmStrategy(AlgorithmStrategy strategy) Add an algorithm strategy to the list of strategies.
void	foundNewOptimalSolution(SolutionJudge source, java.util.List<Trial> solutions, Trial solution) Event indicating that a new optimal solution has been found.
AlgorithmPool	getAlgorithmPool() Get the algorithm pool.
java.util.List<AlgorithmStrategy>	getStrategies() Get the algorithm strategies.
AlgorithmStrategy	nextStrategy() Get the next strategy to execute by sorting strategies by efficiency and then picking a strategy randomly but weighted by the probability ratio for each successive strategy.
void	removeAlgorithmMarketListener(AlgorithmMarketListener listener) Remove the listener from receiving AlgorithmMarket events.
void	reset() reset the market
void	setAlgorithmPool(AlgorithmPool pool) Set the algorithm pool.
void	setAlgorithmStrategies(java.util.List<AlgorithmStrategy> strategies) Set the list of strategies.
void	setAlgorithmStrategy(AlgorithmStrategy strategy) Set the strategy.
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 algorithmSchedule, Trial trial) Handle a message that a trial has been scored.
void	trialVetoed(AlgorithmSchedule algorithmSchedule, 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

_strategies

protected java.util.List<AlgorithmStrategy> _strategies

the list of strategies in the market sorted by efficiency so the most efficient strategies appear first

_algorithmPool

protected AlgorithmPool _algorithmPool

the pool of algorithms from which to pick an algorithm

_messageCenter

protected MessageCenter _messageCenter

message center which dispatches events to registered listeners

_eventProxy

protected AlgorithmMarketListener _eventProxy

proxy which forwards events to registered listeners

Constructor Detail

AlgorithmMarket

public AlgorithmMarket(AlgorithmPool pool,
                       java.util.List<AlgorithmStrategy> strategies)

Primary Constructor

Parameters:

pool - the pool of algorithms

strategies - the list of strategies

AlgorithmMarket

public AlgorithmMarket(AlgorithmPool pool)

Constructor

Parameters:

pool - the pool of algorithms

AlgorithmMarket

public AlgorithmMarket(AlgorithmPool pool,
                       AlgorithmStrategy strategy)

Constructor

Parameters:

pool - the pool of algorithms

strategy - the only strategy to use in the market

AlgorithmMarket

public AlgorithmMarket(SearchAlgorithm algorithm)

Constructor

Parameters:

algorithm - the only algorithm to use which also implies the single algorithm strategy

AlgorithmMarket

public AlgorithmMarket(java.util.List<AlgorithmStrategy> strategies)

Constructor

Parameters:

strategies - the list of strategies

AlgorithmMarket

public AlgorithmMarket()

Constructor using the default algorithm pool and the default strategies.

Method Detail

reset

public void reset()

reset the market

addAlgorithmMarketListener

public void addAlgorithmMarketListener(AlgorithmMarketListener listener)

Add a listener to receive AlgorithmMarket events.

Parameters:

listener - the listener to add for receiving algorithm market events

removeAlgorithmMarketListener

public void removeAlgorithmMarketListener(AlgorithmMarketListener listener)

Remove the listener from receiving AlgorithmMarket events.

Parameters:

listener - the listener to remove from receiving algorithm market events

setProblem

public void setProblem(Problem problem)

Assign a new problem.

Parameters:

problem - the new problem

getAlgorithmPool

public AlgorithmPool getAlgorithmPool()

Get the algorithm pool.

Returns:

The algorithm pool.

getStrategies

public java.util.List<AlgorithmStrategy> getStrategies()

Get the algorithm strategies.

Returns:

The list of strategies.

setAlgorithmStrategies

public void setAlgorithmStrategies(java.util.List<AlgorithmStrategy> strategies)

Set the list of strategies.

Parameters:

strategies - The list of strategies.

setAlgorithmStrategy

public void setAlgorithmStrategy(AlgorithmStrategy strategy)

Set the strategy.

Parameters:

strategy - The algorithm strategy to set the list with.

addAlgorithmStrategy

public void addAlgorithmStrategy(AlgorithmStrategy strategy)

Add an algorithm strategy to the list of strategies.

Parameters:

strategy - The algorithm strategy to add.

setAlgorithmPool

public void setAlgorithmPool(AlgorithmPool pool)

Set the algorithm pool.

Parameters:

pool - The algorithm pool used to set the local algorithm pool.

nextStrategy

public AlgorithmStrategy nextStrategy()

Get the next strategy to execute by sorting strategies by efficiency and then picking a strategy randomly but weighted by the probability ratio for each successive strategy.

Returns:

the next strategy

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

trialScored

public void trialScored(AlgorithmSchedule algorithmSchedule,
                        Trial trial)

Handle 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)

Handle 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.

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.