xal.extension.solver.market

Class AlgorithmStrategy

java.lang.Object

xal.extension.solver.market.AlgorithmStrategy

All Implemented Interfaces:

AlgorithmPoolListener, AlgorithmScheduleListener, SolutionJudgeListener

Direct Known Subclasses:

RandomAlgorithmStrategy, SingleAlgorithmStrategy

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

AlgorithmStrategy keeps track of algorithm strategies.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_efficiency measure of this strategy's running efficiency in solving the problem

Constructor Summary

Constructors

Constructor and Description
AlgorithmStrategy(AlgorithmPool pool) Constructor

Method Summary

Modifier and Type	Method and Description
void	algorithmAdded(AlgorithmPool source, SearchAlgorithm algorithm) Send a message that an algorithm.
void	algorithmAvailable(AlgorithmPool source, SearchAlgorithm algorithm) Send a message that an algorithm is available.
void	algorithmRemoved(AlgorithmPool source, SearchAlgorithm algorithm) Send a message that an algorithm was removed from the pool.
void	algorithmUnavailable(AlgorithmPool source, SearchAlgorithm algorithm) Send a message that an algorithm is unvavailable.
void	execute(AlgorithmSchedule schedule, ScoreBoard scoreboard) Execute the proposed runs.
void	foundNewOptimalSolution(SolutionJudge source, java.util.List<Trial> solutions, Trial solution) Send a message that a new optimal solution has been found.
double	getEfficiency() Get this strategy's efficiency for improving satisfaction.
abstract java.lang.String	getLabel() Return the label for the algorithm strategy.
protected static int	getNearestIntegerInRange(int target, int lower, int upper) Get the nearest integer to the specified target that is within the specified range.
protected static int	getRunCount(int targetCount, SearchAlgorithm algorithm) Get the number of runs that is nearest the target count but withing the algorithm's accepted range.
protected abstract AlgorithmRunStack	proposeRuns() Propose some algorithms that should be run.
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.
java.lang.String	toString() Get a string representation of this strategy.
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, wait, wait, wait

Field Detail

_efficiency

protected double _efficiency

measure of this strategy's running efficiency in solving the problem

Constructor Detail

AlgorithmStrategy

public AlgorithmStrategy(AlgorithmPool pool)

Constructor

Parameters:

pool - the pool of algorithms from which to choose

Method Detail

proposeRuns

protected abstract AlgorithmRunStack proposeRuns()

Propose some algorithms that should be run.

Returns:

An algorithm run stack representing the proposed runs.

getLabel

public abstract java.lang.String getLabel()

Return the label for the algorithm strategy. It is also used for deterministic sorting (see makeEfficiencyComparator method).

Returns:

The label.

getEfficiency

public final double getEfficiency()

Get this strategy's efficiency for improving satisfaction.

Returns:

the efficiency

toString

public java.lang.String toString()

Get a string representation of this strategy.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this strategy

getNearestIntegerInRange

protected static int getNearestIntegerInRange(int target,
                                              int lower,
                                              int upper)

Get the nearest integer to the specified target that is within the specified range.

Parameters:

target - the target that we are trying to meet

lower - the minimum value of the allowed range

upper - the maximum value of the allowed range

Returns:

the nearest integer to the target, but within the specified range

getRunCount

protected static int getRunCount(int targetCount,
                                 SearchAlgorithm algorithm)

Get the number of runs that is nearest the target count but withing the algorithm's accepted range.

Parameters:

targetCount - the target that we are trying to meet

algorithm - the algorithm that specifies the valid range

Returns:

the suggested run count that is nearest the target count but within the specified algorithm's valid range

execute

public final void execute(AlgorithmSchedule schedule,
                          ScoreBoard scoreboard)

Execute the proposed runs.

Parameters:

schedule - the schedule requesting the strategy execution

scoreboard - the scoreboard of solver status

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

algorithmAdded

public void algorithmAdded(AlgorithmPool source,
                           SearchAlgorithm algorithm)

Send a message that an algorithm. was added to the pool.

Specified by:

algorithmAdded in interface AlgorithmPoolListener

Parameters:

source - The source of the added algorithm.

algorithm - The algorithm which was added.

algorithmRemoved

public void algorithmRemoved(AlgorithmPool source,
                             SearchAlgorithm algorithm)

Send a message that an algorithm was removed from the pool.

Specified by:

algorithmRemoved in interface AlgorithmPoolListener

Parameters:

source - The source of the removed algorithm.

algorithm - The algorithm which was removed.

algorithmAvailable

public void algorithmAvailable(AlgorithmPool source,
                               SearchAlgorithm algorithm)

Send a message that an algorithm is available.

Specified by:

algorithmAvailable in interface AlgorithmPoolListener

Parameters:

source - The source of the available algorithm.

algorithm - The algorithm which has become available.

algorithmUnavailable

public void algorithmUnavailable(AlgorithmPool source,
                                 SearchAlgorithm algorithm)

Send a message that an algorithm is unvavailable.

Specified by:

algorithmUnavailable in interface AlgorithmPoolListener

Parameters:

source - The source of the unavailable algorithm.

algorithm - The algorithm which has become unavailable.

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.