org.optaplanner.core.impl.solver.termination
Class PhaseToSolverTerminationBridge
java.lang.Object
org.optaplanner.core.impl.solver.event.SolverLifecycleListenerAdapter
org.optaplanner.core.impl.phase.event.PhaseLifecycleListenerAdapter
org.optaplanner.core.impl.solver.termination.AbstractTermination
org.optaplanner.core.impl.solver.termination.PhaseToSolverTerminationBridge
- All Implemented Interfaces:
- EventListener, PhaseLifecycleListener, SolverLifecycleListener, Termination
public class PhaseToSolverTerminationBridge
- extends AbstractTermination
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PhaseToSolverTerminationBridge
public PhaseToSolverTerminationBridge(Termination solverTermination)
solvingStarted
public void solvingStarted(DefaultSolverScope solverScope)
- Specified by:
solvingStarted
in interface SolverLifecycleListener
- Overrides:
solvingStarted
in class SolverLifecycleListenerAdapter
phaseStarted
public void phaseStarted(AbstractPhaseScope phaseScope)
- Specified by:
phaseStarted
in interface PhaseLifecycleListener
- Overrides:
phaseStarted
in class PhaseLifecycleListenerAdapter
stepStarted
public void stepStarted(AbstractStepScope stepScope)
- Specified by:
stepStarted
in interface PhaseLifecycleListener
- Overrides:
stepStarted
in class PhaseLifecycleListenerAdapter
stepEnded
public void stepEnded(AbstractStepScope stepScope)
- Specified by:
stepEnded
in interface PhaseLifecycleListener
- Overrides:
stepEnded
in class PhaseLifecycleListenerAdapter
phaseEnded
public void phaseEnded(AbstractPhaseScope phaseScope)
- Specified by:
phaseEnded
in interface PhaseLifecycleListener
- Overrides:
phaseEnded
in class PhaseLifecycleListenerAdapter
solvingEnded
public void solvingEnded(DefaultSolverScope solverScope)
- Specified by:
solvingEnded
in interface SolverLifecycleListener
- Overrides:
solvingEnded
in class SolverLifecycleListenerAdapter
isSolverTerminated
public boolean isSolverTerminated(DefaultSolverScope solverScope)
- Description copied from interface:
Termination
- Called by the
Solver
after every phase to determine if the search should stop.
- Parameters:
solverScope
- never null
- Returns:
- true if the search should terminate.
isPhaseTerminated
public boolean isPhaseTerminated(AbstractPhaseScope phaseScope)
- Description copied from interface:
Termination
- Called by the
Phase
after every step and every move to determine if the search should stop.
- Parameters:
phaseScope
- never null
- Returns:
- true if the search should terminate.
calculateSolverTimeGradient
public double calculateSolverTimeGradient(DefaultSolverScope solverScope)
- Description copied from interface:
Termination
- A timeGradient is a relative estimate of how long the search will continue.
Clients that use a timeGradient should cache it at the start of a single step
because some implementations are not time-stable.
If a timeGradient can not be calculated, it should return -1.0.
Several implementations (such a
SimulatedAnnealingAcceptor
) require a correctly implemented timeGradient.
A Termination's timeGradient can be requested after they are terminated, so implementations
should be careful not to return a timeGradient above 1.0.
- Parameters:
solverScope
- never null
- Returns:
- timeGradient t for which 0.0 <= t <= 1.0 or -1.0 when it is not supported.
At the start of a solver t is 0.0 and at the end t would be 1.0.
calculatePhaseTimeGradient
public double calculatePhaseTimeGradient(AbstractPhaseScope phaseScope)
- Description copied from interface:
Termination
- See
Termination.calculateSolverTimeGradient(DefaultSolverScope)
.
- Parameters:
phaseScope
- never null
- Returns:
- timeGradient t for which 0.0 <= t <= 1.0 or -1.0 when it is not supported.
At the start of a phase t is 0.0 and at the end t would be 1.0.
Copyright © 2006-2014 JBoss by Red Hat. All Rights Reserved.