OptaPlanner core 6.0.0.CR2

org.optaplanner.core.impl.termination
Class OrCompositeTermination

java.lang.Object
  extended by org.optaplanner.core.impl.solver.event.SolverLifecycleListenerAdapter
      extended by org.optaplanner.core.impl.phase.event.SolverPhaseLifecycleListenerAdapter
          extended by org.optaplanner.core.impl.termination.AbstractTermination
              extended by org.optaplanner.core.impl.termination.AbstractCompositeTermination
                  extended by org.optaplanner.core.impl.termination.OrCompositeTermination
All Implemented Interfaces:
EventListener, SolverPhaseLifecycleListener, SolverLifecycleListener, Termination

public class OrCompositeTermination
extends AbstractCompositeTermination


Field Summary
 
Fields inherited from class org.optaplanner.core.impl.termination.AbstractCompositeTermination
terminationList
 
Fields inherited from class org.optaplanner.core.impl.termination.AbstractTermination
logger
 
Constructor Summary
OrCompositeTermination()
           
OrCompositeTermination(Termination... terminations)
           
 
Method Summary
 double calculatePhaseTimeGradient(AbstractSolverPhaseScope phaseScope)
          Calculates the minimum timeGradient of all Terminations.
 double calculateSolverTimeGradient(DefaultSolverScope solverScope)
          Calculates the minimum timeGradient of all Terminations.
 boolean isPhaseTerminated(AbstractSolverPhaseScope phaseScope)
          Called by the SolverPhase after every step and every move to determine if the search should stop.
 boolean isSolverTerminated(DefaultSolverScope solverScope)
          Called by the Solver after every phase to determine if the search should stop.
 
Methods inherited from class org.optaplanner.core.impl.termination.AbstractCompositeTermination
phaseEnded, phaseStarted, setTerminationList, solvingEnded, solvingStarted, stepEnded, stepStarted
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OrCompositeTermination

public OrCompositeTermination()

OrCompositeTermination

public OrCompositeTermination(Termination... terminations)
Method Detail

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 any of the Termination is terminated.

isPhaseTerminated

public boolean isPhaseTerminated(AbstractSolverPhaseScope phaseScope)
Description copied from interface: Termination
Called by the SolverPhase after every step and every move to determine if the search should stop.

Parameters:
phaseScope - never null
Returns:
true if any of the Termination is terminated.

calculateSolverTimeGradient

public double calculateSolverTimeGradient(DefaultSolverScope solverScope)
Calculates the minimum timeGradient of all Terminations. Not supported timeGradients (-1.0) are ignored.

Parameters:
solverScope - never null
Returns:
the maximum timeGradient of the Terminations.

calculatePhaseTimeGradient

public double calculatePhaseTimeGradient(AbstractSolverPhaseScope phaseScope)
Calculates the minimum timeGradient of all Terminations. Not supported timeGradients (-1.0) are ignored.

Parameters:
phaseScope - never null
Returns:
the maximum timeGradient of the Terminations.

OptaPlanner core 6.0.0.CR2

Copyright © 2006-2013 JBoss by Red Hat. All Rights Reserved.