xal.extension.solver.market

Class SingleAlgorithmStrategy

java.lang.Object

xal.extension.solver.market.AlgorithmStrategy

xal.extension.solver.market.SingleAlgorithmStrategy

All Implemented Interfaces:

AlgorithmPoolListener, AlgorithmScheduleListener, SolutionJudgeListener

public class SingleAlgorithmStrategy
extends AlgorithmStrategy

SingleAlgorithmStrategy is a subclass of algorithm strategy and generates algorithm runs using a single algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchAlgorithm	_algorithm the single algorithm to schedule

Fields inherited from class xal.extension.solver.market.AlgorithmStrategy

_efficiency

Constructor Summary

Constructors

Constructor and Description
SingleAlgorithmStrategy(AlgorithmPool pool, SearchAlgorithm algorithm) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLabel() Return the label for the algorithm strategy.
SearchAlgorithm	getSearchAlgorithm() Get the search algorithm.
protected AlgorithmRunStack	proposeRuns() The default method for generating an algorithm run stack.

Methods inherited from class xal.extension.solver.market.AlgorithmStrategy

algorithmAdded, algorithmAvailable, algorithmRemoved, algorithmUnavailable, execute, foundNewOptimalSolution, getEfficiency, getNearestIntegerInRange, getRunCount, strategyExecuted, strategyWillExecute, toString, trialScored, trialVetoed

Methods inherited from class java.lang.Object

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

Field Detail

_algorithm

protected final SearchAlgorithm _algorithm

the single algorithm to schedule

Constructor Detail

SingleAlgorithmStrategy

public SingleAlgorithmStrategy(AlgorithmPool pool,
                               SearchAlgorithm algorithm)

Constructor

Parameters:

pool - the pool of algorithms

algorithm - the algorithm to schedule

Method Detail

getLabel

public java.lang.String getLabel()

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

Specified by:

getLabel in class AlgorithmStrategy

Returns:

The label.

getSearchAlgorithm

public SearchAlgorithm getSearchAlgorithm()

Get the search algorithm.

Returns:

The searchAlgorithm value

proposeRuns

protected AlgorithmRunStack proposeRuns()

The default method for generating an algorithm run stack. Returns a stack populated with a single algorithm.

Specified by:

proposeRuns in class AlgorithmStrategy

Returns:

An algorithm run stack representing the proposed runs.