Uses of Class
xal.extension.solver.algorithm.SearchAlgorithm

Packages that use SearchAlgorithm

Package	Description
xal.extension.solver
xal.extension.solver.algorithm
xal.extension.solver.market

Uses of SearchAlgorithm in xal.extension.solver

Fields in xal.extension.solver declared as SearchAlgorithm

Modifier and Type	Field	Description
protected final SearchAlgorithm	Trial.searchAlgorithm	the algorithm that generated this trial

Methods in xal.extension.solver that return SearchAlgorithm

Modifier and Type	Method	Description
SearchAlgorithm	Trial.getAlgorithm()	Get the search algorithm that generated this trial.

Methods in xal.extension.solver that return types with arguments of type SearchAlgorithm

Modifier and Type	Method	Description
static Collection<SearchAlgorithm>	AlgorithmPool.generateDefaultAlgorithms()	Get all the algorithms.
Collection<SearchAlgorithm>	AlgorithmPool.getAlgorithms()	Get a copy of the algorithms.
Collection<SearchAlgorithm>	AlgorithmPool.getAvailableAlgorithms()	Get the available algorithms.

Methods in xal.extension.solver with parameters of type SearchAlgorithm

Modifier and Type	Method	Description
void	AlgorithmPool.addAlgorithm(SearchAlgorithm algorithm)	Add an algorithm to the pool.
void	AlgorithmPoolListener.algorithmAdded(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm. was added to the pool.
void	Solver.algorithmAdded(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm. was added to the pool.
void	AlgorithmPool.algorithmAvailable(SearchAlgorithm source)	Send a message that an algorithm is available.
void	AlgorithmPoolListener.algorithmAvailable(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm is available.
void	Solver.algorithmAvailable(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm is available.
void	AlgorithmPoolListener.algorithmRemoved(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm was removed from the pool.
void	Solver.algorithmRemoved(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm was removed from the pool.
void	AlgorithmPool.algorithmRunExecuted(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack has completed.
void	AlgorithmScheduleListener.algorithmRunExecuted(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack has completed.
void	ScoreBoard.algorithmRunExecuted(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack has completed.
void	AlgorithmPool.algorithmRunWillExecute(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack will start.
void	AlgorithmScheduleListener.algorithmRunWillExecute(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack will start.
void	ScoreBoard.algorithmRunWillExecute(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack will start.
void	AlgorithmPool.algorithmUnavailable(SearchAlgorithm source)	Send a message that an algorithm is not available.
void	AlgorithmPoolListener.algorithmUnavailable(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm is unavailable.
void	Solver.algorithmUnavailable(AlgorithmPool source, SearchAlgorithm algorithm)	Send a message that an algorithm is unavailable.
Trial	AlgorithmSchedule.evaluateTrialPoint(SearchAlgorithm searchAlgorithm, TrialPoint trialPoint)	Evaluate the specified trial point or return null if the run has been terminated.
void	AlgorithmPool.removeAlgorithm(SearchAlgorithm algorithm)	Remove an algorithm from the pool.
void	AlgorithmPool.setAlgorithm(SearchAlgorithm algorithm)	Set the algorithm as the sole algorithm in the pool.

Method parameters in xal.extension.solver with type arguments of type SearchAlgorithm

Modifier and Type	Method	Description
void	AlgorithmPool.addAlgorithms(Collection<SearchAlgorithm> algorithms)	Add existing algorithms to the algorithm list.
void	AlgorithmPool.removeAlgorithms(Collection<SearchAlgorithm> algorithms)	Remove the specified algorithms.

Constructors in xal.extension.solver with parameters of type SearchAlgorithm

Modifier	Constructor	Description
	AlgorithmPool(SearchAlgorithm algorithm)	Creates a new AlgorithmPool instance Constructor that takes a list of algorithms
	Solver(SearchAlgorithm algorithm, Stopper stopper)	Constructor using the specified stopper and only the specified algorithm.
	Solver(SearchAlgorithm algorithm, Stopper stopper, SolutionJudge solutionJudge)	Constructor using the specified stopper, solution judge and only the specified algorithm.
	Trial(Problem problem, TrialPoint trialPoint, SearchAlgorithm algorithm)	Primary Constructor.

Constructor parameters in xal.extension.solver with type arguments of type SearchAlgorithm

Modifier	Constructor	Description
	AlgorithmPool(Collection<SearchAlgorithm> algorithms)	Creates a new AlgorithmPool instance Constructor that takes a list of algorithms

Uses of SearchAlgorithm in xal.extension.solver.algorithm

Subclasses of SearchAlgorithm in xal.extension.solver.algorithm

Modifier and Type	Class	Description
class	DirectedStep	Based on the acceleration-step of Forsythe and Motzkin
class	InitialAlgorithm	InitialAlgorithm
class	RandomSearch	RandomSearch returns a random trial point that lies within the bounds specified by the variables.
class	RandomShrinkSearch	RandomSearchAlgorithm looks for points bounded by the specified variable limits.
class	SimplexSearchAlgorithm	Simplex optimization search algorithm.

Fields in xal.extension.solver.algorithm with type parameters of type SearchAlgorithm

Modifier and Type	Field	Description
static final Comparator<SearchAlgorithm>	SearchAlgorithm.EFFICIENCY_COMPARATOR	comparator for sorting based on efficiency

Methods in xal.extension.solver.algorithm with parameters of type SearchAlgorithm

Modifier and Type	Method	Description
void	DirectedStep.algorithmAvailable(SearchAlgorithm source)	Handle a message that an algorithm is available.
void	RandomSearch.algorithmAvailable(SearchAlgorithm source)	Handle a message that an algorithm is available.
void	RandomShrinkSearch.algorithmAvailable(SearchAlgorithm source)	Handle a message that an algorithm is available.
void	SearchAlgorithmListener.algorithmAvailable(SearchAlgorithm source)	Send a message that an algorithm is available.
void	SearchAlgorithm.algorithmRunExecuted(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack has completed.
void	SearchAlgorithm.algorithmRunWillExecute(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack will start.
void	DirectedStep.algorithmUnavailable(SearchAlgorithm source)	Handle a message that an algorithm is not available.
void	RandomSearch.algorithmUnavailable(SearchAlgorithm source)	Handle a message that an algorithm is not available.
void	RandomShrinkSearch.algorithmUnavailable(SearchAlgorithm source)	Handle a message that an algorithm is not available.
void	SearchAlgorithmListener.algorithmUnavailable(SearchAlgorithm source)	Send a message that an algorithm is not available.

Uses of SearchAlgorithm in xal.extension.solver.market

Methods in xal.extension.solver.market that return SearchAlgorithm

Modifier and Type	Method	Description
SearchAlgorithm	AlgorithmMarket.nextAlgorithm()	Get the next algorithm to execute by sorting algorithms by efficiency and then picking a algorithm randomly but weighted by the probability ratio for each successive algorithm.

Methods in xal.extension.solver.market that return types with arguments of type SearchAlgorithm

Modifier and Type	Method	Description
List<SearchAlgorithm>	AlgorithmMarket.getAlgorithms()	Get the algorithm List.

Methods in xal.extension.solver.market with parameters of type SearchAlgorithm

Modifier and Type	Method	Description
void	AlgorithmMarket.algorithmRunExecuted(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack has completed.
void	AlgorithmMarket.algorithmRunWillExecute(AlgorithmSchedule schedule, SearchAlgorithm algorithm, ScoreBoard scoreBoard)	Handle an event where a new algorithm run stack will start.

Constructors in xal.extension.solver.market with parameters of type SearchAlgorithm

Modifier	Constructor	Description
	AlgorithmMarket(SearchAlgorithm algorithm)	Constructor