Class IncrementalScoreDirector<Solution_>
- java.lang.Object
-
- org.optaplanner.core.impl.score.director.AbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
- org.optaplanner.core.impl.score.director.incremental.IncrementalScoreDirector<Solution_>
-
- Type Parameters:
Solution_
- the solution type, the class with thePlanningSolution
annotation
- All Implemented Interfaces:
AutoCloseable
,Cloneable
,InnerScoreDirector<Solution_>
,ScoreDirector<Solution_>
public class IncrementalScoreDirector<Solution_> extends AbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
Incremental java implementation ofScoreDirector
, which only recalculates theScore
of the part of theworking solution
that changed, instead of the going through the entirePlanningSolution
. This is incremental calculation, which is fast.- See Also:
ScoreDirector
-
-
Field Summary
-
Fields inherited from class org.optaplanner.core.impl.score.director.AbstractScoreDirector
allChangesWillBeUndoneBeforeStepEnds, calculationCount, constraintMatchEnabledPreference, logger, lookUpEnabled, lookUpManager, scoreDirectorFactory, variableListenerSupport, workingEntityListRevision, workingInitScore, workingSolution
-
-
Constructor Summary
Constructors Constructor Description IncrementalScoreDirector(IncrementalScoreDirectorFactory<Solution_> scoreDirectorFactory, boolean lookUpEnabled, boolean constraintMatchEnabledPreference, IncrementalScoreCalculator<Solution_,?> incrementalScoreCalculator)
-
Method Summary
-
Methods inherited from class org.optaplanner.core.impl.score.director.AbstractScoreDirector
afterEntityAdded, afterEntityRemoved, afterVariableChanged, assertExpectedUndoMoveScore, assertExpectedWorkingScore, assertPredictedScoreFromScratch, assertShadowVariablesAreNotStale, assertWorkingScoreFromScratch, beforeEntityAdded, beforeEntityRemoved, beforeVariableChanged, buildScoreCorruptionAnalysis, buildShadowVariableAnalysis, changeVariableFacade, clone, cloneSolution, cloneWorkingSolution, close, createChildThreadScoreDirector, createShadowVariablesViolationMessage, doAndProcessMove, doAndProcessMove, explainScore, getCalculationCount, getScoreDefinition, getScoreDirectorFactory, getSolutionDescriptor, getSupplyManager, getWorkingEntityCount, getWorkingEntityList, getWorkingEntityListRevision, getWorkingSolution, getWorkingValueCount, isAllChangesWillBeUndoneBeforeStepEnds, isConstraintMatchEnabledPreference, isLookUpEnabled, isWorkingEntityListDirty, lookUpWorkingObject, lookUpWorkingObjectOrReturnNull, overwriteConstraintMatchEnabledPreference, resetCalculationCount, setAllChangesWillBeUndoneBeforeStepEnds, setCalculatedScore, setWorkingEntityListDirty, toString, triggerVariableListeners
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.optaplanner.core.impl.score.director.ScoreDirector
dispose
-
-
-
-
Constructor Detail
-
IncrementalScoreDirector
public IncrementalScoreDirector(IncrementalScoreDirectorFactory<Solution_> scoreDirectorFactory, boolean lookUpEnabled, boolean constraintMatchEnabledPreference, IncrementalScoreCalculator<Solution_,?> incrementalScoreCalculator)
-
-
Method Detail
-
getIncrementalScoreCalculator
public IncrementalScoreCalculator<Solution_,?> getIncrementalScoreCalculator()
-
setWorkingSolution
public void setWorkingSolution(Solution_ workingSolution)
Description copied from interface:ScoreDirector
Theworking solution
must never be the same instance as thebest solution
, it should be a (un)changed clone.Only call this method on a separate
ScoreDirector
instance, built bySolverFactory.getScoreDirectorFactory()
, not on the one used inside theSolver
itself.- Specified by:
setWorkingSolution
in interfaceScoreDirector<Solution_>
- Overrides:
setWorkingSolution
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
- Parameters:
workingSolution
- never null
-
calculateScore
public Score calculateScore()
Description copied from interface:ScoreDirector
Calculates theScore
and updates theworking solution
accordingly.- Returns:
- never null, the
Score
of theworking solution
-
isConstraintMatchEnabled
public boolean isConstraintMatchEnabled()
- Returns:
- true if
ScoreDirector.getConstraintMatchTotals()
,ScoreDirector.getConstraintMatchTotalMap()
andScoreDirector.getIndictmentMap()
can be called
-
getConstraintMatchTotals
public Collection<ConstraintMatchTotal> getConstraintMatchTotals()
Description copied from interface:ScoreDirector
Explains theScore
ofScoreDirector.calculateScore()
by splitting it up perConstraint
.The sum of
ConstraintMatchTotal.getScore()
equalsScoreDirector.calculateScore()
.Call
ScoreDirector.calculateScore()
before calling this method, unless that method has already been called since the lastPlanningVariable
changes.- Returns:
- never null
- See Also:
ScoreDirector.getConstraintMatchTotalMap()
,ScoreDirector.getIndictmentMap()
-
getConstraintMatchTotalMap
public Map<String,ConstraintMatchTotal> getConstraintMatchTotalMap()
Description copied from interface:ScoreDirector
Explains theScore
ofScoreDirector.calculateScore()
by splitting it up perConstraint
.The sum of
ConstraintMatchTotal.getScore()
equalsScoreDirector.calculateScore()
.Call
ScoreDirector.calculateScore()
before calling this method, unless that method has already been called since the lastPlanningVariable
changes.- Returns:
- never null, the key is the
constraintId
(to create one, useConstraintMatchTotal.composeConstraintId(String, String)
). - See Also:
ScoreDirector.getIndictmentMap()
-
getIndictmentMap
public Map<Object,Indictment> getIndictmentMap()
Description copied from interface:ScoreDirector
Explains the impact of each planning entity or problem fact on theScore
. AnIndictment
is basically the inverse of aConstraintMatchTotal
: it is aScore
total for each justificationObject
inConstraintMatch.getJustificationList()
.The sum of
ConstraintMatchTotal.getScore()
differs fromScoreDirector.calculateScore()
because eachConstraintMatch.getScore()
is counted for each justification inConstraintMatch.getJustificationList()
.Call
ScoreDirector.calculateScore()
before calling this method, unless that method has already been called since the lastPlanningVariable
changes.- Returns:
- never null, the key is a
problem fact
or aplanning entity
- See Also:
ScoreDirector.getConstraintMatchTotalMap()
-
beforeEntityAdded
public void beforeEntityAdded(EntityDescriptor<Solution_> entityDescriptor, Object entity)
- Overrides:
beforeEntityAdded
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
afterEntityAdded
public void afterEntityAdded(EntityDescriptor<Solution_> entityDescriptor, Object entity)
- Overrides:
afterEntityAdded
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
beforeVariableChanged
public void beforeVariableChanged(VariableDescriptor variableDescriptor, Object entity)
- Specified by:
beforeVariableChanged
in interfaceScoreDirector<Solution_>
- Overrides:
beforeVariableChanged
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
afterVariableChanged
public void afterVariableChanged(VariableDescriptor variableDescriptor, Object entity)
- Specified by:
afterVariableChanged
in interfaceScoreDirector<Solution_>
- Overrides:
afterVariableChanged
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
beforeEntityRemoved
public void beforeEntityRemoved(EntityDescriptor<Solution_> entityDescriptor, Object entity)
- Overrides:
beforeEntityRemoved
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
afterEntityRemoved
public void afterEntityRemoved(EntityDescriptor<Solution_> entityDescriptor, Object entity)
- Overrides:
afterEntityRemoved
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
beforeProblemFactAdded
public void beforeProblemFactAdded(Object problemFact)
- Specified by:
beforeProblemFactAdded
in interfaceScoreDirector<Solution_>
- Overrides:
beforeProblemFactAdded
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
afterProblemFactAdded
public void afterProblemFactAdded(Object problemFact)
- Specified by:
afterProblemFactAdded
in interfaceScoreDirector<Solution_>
- Overrides:
afterProblemFactAdded
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
beforeProblemPropertyChanged
public void beforeProblemPropertyChanged(Object problemFactOrEntity)
- Specified by:
beforeProblemPropertyChanged
in interfaceScoreDirector<Solution_>
- Overrides:
beforeProblemPropertyChanged
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
afterProblemPropertyChanged
public void afterProblemPropertyChanged(Object problemFactOrEntity)
- Specified by:
afterProblemPropertyChanged
in interfaceScoreDirector<Solution_>
- Overrides:
afterProblemPropertyChanged
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
beforeProblemFactRemoved
public void beforeProblemFactRemoved(Object problemFact)
- Specified by:
beforeProblemFactRemoved
in interfaceScoreDirector<Solution_>
- Overrides:
beforeProblemFactRemoved
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
afterProblemFactRemoved
public void afterProblemFactRemoved(Object problemFact)
- Specified by:
afterProblemFactRemoved
in interfaceScoreDirector<Solution_>
- Overrides:
afterProblemFactRemoved
in classAbstractScoreDirector<Solution_,IncrementalScoreDirectorFactory<Solution_>>
-
-