AlgorithmSchedule

java.lang.Object
- xal.extension.solver.AlgorithmSchedule

```
public class AlgorithmSchedule
extends java.lang.Object
```
AlgorithmSchedule keeps track of and executes the next algorithm based on its score. Schedule also sets a trial and a stopper.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AlgorithmScheduleListener`	`_eventProxy` proxy which forwarding messages to registered listeners
`protected AlgorithmMarket`	`_market` the market of algorithm runs
`protected MessageCenter`	`_messageCenter` message center for dispatching messages
`protected Problem`	`_problem` the problem to solve
`protected Solver`	`_solver` the solver running the schedule
`protected Stopper`	`_stopper` determines when to stop the trials

Constructor Summary

Constructors
Constructor and Description

AlgorithmSchedule(Solver solver, AlgorithmMarket market, Stopper stopper)
Creates a new instance of Schedule.

Constructors
Constructor and Description
`AlgorithmSchedule(Solver solver, AlgorithmMarket market, Stopper stopper)` Creates a new instance of Schedule.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlgorithmScheduleListener(AlgorithmScheduleListener aListener)` Add an algorithm schedule listener.
`Trial`	`evaluateTrialPoint(AlgorithmRun algorithmRun, TrialPoint trialPoint)` Evaluate the specified trial point or return null if the run has been terminated.
`void`	`execute()` Execute the search schedule.
`protected void`	`execute(AlgorithmStrategy strategy)` Execute the specified strategy.
`AlgorithmMarket`	`getMarket()` Get the algorithm market.
`Stopper`	`getStopper()` Get the stopper.
`void`	`removeAlgorithmScheduleListener(AlgorithmScheduleListener aListener)` Remove an algorithm schedule listener.
`void`	`reset()` Reset the algorithm run stack.
`protected void`	`score(Trial trial)` Score the trial.
`void`	`setProblem(Problem problem)` Assign a new problem.
`void`	`setStopper(Stopper stopper)` Assign a new stopper.
`boolean`	`shouldExecute()` Determine whether to continue executing the schedule.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _messageCenter
```
protected MessageCenter _messageCenter
```
    message center for dispatching messages
  - _eventProxy
```
protected AlgorithmScheduleListener _eventProxy
```
    proxy which forwarding messages to registered listeners
  - _stopper
```
protected volatile Stopper _stopper
```
    determines when to stop the trials
  - _problem
```
protected Problem _problem
```
    the problem to solve
  - _market
```
protected AlgorithmMarket _market
```
    the market of algorithm runs
  - _solver
```
protected Solver _solver
```
    the solver running the schedule
- Constructor Detail
  - AlgorithmSchedule
```
public AlgorithmSchedule(Solver solver,
                         AlgorithmMarket market,
                         Stopper stopper)
```
    Creates a new instance of Schedule.
    
    Parameters:
    
    solver - The solver
    
    market - The market providing runs.
    
    stopper - The stopper which can terminate the schedule.
- Method Detail
  - reset
```
public void reset()
```
    Reset the algorithm run stack.
  - addAlgorithmScheduleListener
```
public void addAlgorithmScheduleListener(AlgorithmScheduleListener aListener)
```
    Add an algorithm schedule listener.
    
    Parameters:
    
    aListener - The listener to add.
  - removeAlgorithmScheduleListener
```
public void removeAlgorithmScheduleListener(AlgorithmScheduleListener aListener)
```
    Remove an algorithm schedule listener.
    
    Parameters:
    
    aListener - The listener to remove.
  - getMarket
```
public AlgorithmMarket getMarket()
```
    Get the algorithm market.
    
    Returns:
    
    the algorithm market
  - setProblem
```
public void setProblem(Problem problem)
```
    Assign a new problem.
    
    Parameters:
    
    problem - the new problem
  - getStopper
```
public Stopper getStopper()
```
    Get the stopper.
    
    Returns:
    
    the stopper
  - setStopper
```
public void setStopper(Stopper stopper)
```
    Assign a new stopper.
    
    Parameters:
    
    stopper - the new stopper
  - shouldExecute
```
public boolean shouldExecute()
```
    Determine whether to continue executing the schedule.
    
    Returns:
    
    true if the stopper allows us to continue executing the schedule and false if not
  - execute
```
public void execute()
```
    Execute the search schedule.
  - execute
```
protected void execute(AlgorithmStrategy strategy)
```
    Execute the specified strategy.
    
    Parameters:
    
    strategy - the strategy to execute.
  - evaluateTrialPoint
```
public Trial evaluateTrialPoint(AlgorithmRun algorithmRun,
                                TrialPoint trialPoint)
```
    Evaluate the specified trial point or return null if the run has been terminated.
    
    Parameters:
    
    trialPoint - the trial point to evaluate
    
    Returns:
    
    a scored trial corresponding to the specified trial point
    
    Throws:
    
    RunTerminationException - if the run has been terminated
  - score
```
protected void score(Trial trial)
```
    Score the trial.
    
    Parameters:
    
    trial - The trial to be scored.

Class AlgorithmSchedule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_messageCenter

_eventProxy

_stopper

_problem

_market

_solver

Constructor Detail

AlgorithmSchedule

Method Detail

reset

addAlgorithmScheduleListener

removeAlgorithmScheduleListener

getMarket

setProblem

getStopper

setStopper

shouldExecute

execute

execute

evaluateTrialPoint

score