Package ai.timefold.solver.core.impl.score.director.incremental

Class IncrementalScoreDirector<Solution_,Score_ extends Score<Score_>>

java.lang.Object

ai.timefold.solver.core.impl.score.director.AbstractScoreDirector<Solution_,Score_,IncrementalScoreDirectorFactory<Solution_,Score_>>

ai.timefold.solver.core.impl.score.director.incremental.IncrementalScoreDirector<Solution_,Score_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

Score_ - the score type to go with the solution

All Implemented Interfaces:

ScoreDirector<Solution_>, InnerScoreDirector<Solution_,Score_>, AutoCloseable, Cloneable

public class IncrementalScoreDirector<Solution_,Score_ extends Score<Score_>>
extends AbstractScoreDirector<Solution_,Score_,IncrementalScoreDirectorFactory<Solution_,Score_>>

Incremental java implementation of ScoreDirector, which only recalculates the Score of the part of the working solution that changed, instead of the going through the entire PlanningSolution. This is incremental calculation, which is fast.

See Also:

ScoreDirector

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.score.director.AbstractScoreDirector

allChangesWillBeUndoneBeforeStepEnds, calculationCount, constraintMatchEnabledPreference, expectShadowVariablesInCorrectState, logger, lookUpEnabled, lookUpManager, scoreDirectorFactory, variableListenerSupport, workingEntityListRevision, workingInitScore, workingSolution

Constructor Summary

Constructors

Constructor	Description
IncrementalScoreDirector(IncrementalScoreDirectorFactory<Solution_,Score_> scoreDirectorFactory, boolean lookUpEnabled, boolean constraintMatchEnabledPreference, boolean expectShadowVariablesInCorrectState, IncrementalScoreCalculator<Solution_,Score_> incrementalScoreCalculator)

Method Summary

Modifier and Type	Method	Description
void	afterEntityAdded(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	afterEntityRemoved(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	afterListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor, Object entity, int fromIndex, int toIndex)	Notify the score director after a list variable changes.
void	afterListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that was assigned (added to a list variable of one entity without being removed from a list variable of another entity).
void	afterListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).
void	afterProblemFactAdded(Object problemFact)
void	afterProblemFactRemoved(Object problemFact)
void	afterProblemPropertyChanged(Object problemFactOrEntity)
void	afterVariableChanged(VariableDescriptor variableDescriptor, Object entity)
void	beforeEntityAdded(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	beforeEntityRemoved(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	beforeListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor, Object entity, int fromIndex, int toIndex)	Notify the score director before a list variable changes.
void	beforeListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that will be assigned (added to a list variable of one entity without being removed from a list variable of another entity).
void	beforeListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that will be unassigned (removed from a list variable of one entity without being added to a list variable of another entity).
void	beforeProblemFactAdded(Object problemFact)
void	beforeProblemFactRemoved(Object problemFact)
void	beforeProblemPropertyChanged(Object problemFactOrEntity)
void	beforeVariableChanged(VariableDescriptor variableDescriptor, Object entity)
Score_	calculateScore()	Calculates the Score and updates the working solution accordingly.
Map<String,ConstraintMatchTotal<Score_>>	getConstraintMatchTotalMap()	Explains the Score of InnerScoreDirector.calculateScore() by splitting it up per Constraint.
IncrementalScoreCalculator<Solution_,Score_>	getIncrementalScoreCalculator()
Map<Object,Indictment<Score_>>	getIndictmentMap()	Explains the impact of each planning entity or problem fact on the Score.
boolean	isConstraintMatchEnabled()
boolean	requiresFlushing()	Some score directors (such as the Drools-based) keep a set of changes that they only apply when InnerScoreDirector.calculateScore() is called.
void	setWorkingSolution(Solution_ workingSolution)	Note: resetting the working solution does NOT substitute the calls to before/after methods of the ProblemChangeDirector during problem changes, as these calls are propagated to variable listeners, which update shadow variables in the working solution to keep it consistent.

Methods inherited from class ai.timefold.solver.core.impl.score.director.AbstractScoreDirector

afterEntityAdded, afterEntityRemoved, afterListVariableChanged, afterListVariableElementAssigned, afterListVariableElementUnassigned, afterVariableChanged, assertExpectedUndoMoveScore, assertExpectedWorkingScore, assertNonNullPlanningIds, assertPredictedScoreFromScratch, assertShadowVariablesAreNotStale, assertWorkingScoreFromScratch, beforeEntityAdded, beforeEntityRemoved, beforeListVariableChanged, beforeListVariableElementAssigned, beforeListVariableElementUnassigned, beforeVariableChanged, buildScoreCorruptionAnalysis, buildShadowVariableAnalysis, changeVariableFacade, clone, cloneSolution, cloneWorkingSolution, close, createChildThreadScoreDirector, doAndProcessMove, doAndProcessMove, expectShadowVariablesInCorrectState, forceTriggerVariableListeners, getCalculationCount, getScoreDefinition, getScoreDirectorFactory, getSolutionDescriptor, getSupplyManager, getWorkingEntityListRevision, getWorkingSolution, incrementCalculationCount, isConstraintConfiguration, 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

Constructor Detail

IncrementalScoreDirector

public IncrementalScoreDirector(IncrementalScoreDirectorFactory<Solution_,Score_> scoreDirectorFactory,
                                boolean lookUpEnabled,
                                boolean constraintMatchEnabledPreference,
                                boolean expectShadowVariablesInCorrectState,
                                IncrementalScoreCalculator<Solution_,Score_> incrementalScoreCalculator)

Method Detail

getIncrementalScoreCalculator

public IncrementalScoreCalculator<Solution_,Score_> getIncrementalScoreCalculator()

setWorkingSolution

public void setWorkingSolution(Solution_ workingSolution)

Description copied from class: AbstractScoreDirector

Note: resetting the working solution does NOT substitute the calls to before/after methods of the ProblemChangeDirector during problem changes, as these calls are propagated to variable listeners, which update shadow variables in the working solution to keep it consistent.

Specified by:

setWorkingSolution in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

setWorkingSolution in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

workingSolution - never null

calculateScore

public Score_ calculateScore()

Description copied from interface: InnerScoreDirector

Calculates the Score and updates the working solution accordingly.

Returns:

never null, the Score of the working solution

isConstraintMatchEnabled

public boolean isConstraintMatchEnabled()

Returns:

true if InnerScoreDirector.getConstraintMatchTotalMap() and InnerScoreDirector.getIndictmentMap() can be called

getConstraintMatchTotalMap

public Map<String,ConstraintMatchTotal<Score_>> getConstraintMatchTotalMap()

Description copied from interface: InnerScoreDirector

Explains the Score of InnerScoreDirector.calculateScore() by splitting it up per Constraint.

The sum of ConstraintMatchTotal.getScore() equals InnerScoreDirector.calculateScore().

Call InnerScoreDirector.calculateScore() before calling this method, unless that method has already been called since the last PlanningVariable changes.

Returns:

never null, the key is the constraintId (to create one, use ConstraintMatchTotal.composeConstraintId(String, String)).

See Also:

InnerScoreDirector.getIndictmentMap()

getIndictmentMap

public Map<Object,Indictment<Score_>> getIndictmentMap()

Description copied from interface: InnerScoreDirector

Explains the impact of each planning entity or problem fact on the Score. An Indictment is basically the inverse of a ConstraintMatchTotal: it is a Score total for each constraint justification.

The sum of ConstraintMatchTotal.getScore() differs from InnerScoreDirector.calculateScore() because each ConstraintMatch.getScore() is counted for each constraint justification.

Call InnerScoreDirector.calculateScore() before calling this method, unless that method has already been called since the last PlanningVariable changes.

Returns:

never null, the key is a problem fact or a planning entity

See Also:

InnerScoreDirector.getConstraintMatchTotalMap()

requiresFlushing

public boolean requiresFlushing()

Description copied from interface: InnerScoreDirector

Some score directors (such as the Drools-based) keep a set of changes that they only apply when InnerScoreDirector.calculateScore() is called. Until that happens, this set accumulates and could possibly act as a memory leak.

Returns:

true if the score director can potentially cause a memory leak due to unflushed changes.

beforeEntityAdded

public void beforeEntityAdded(EntityDescriptor<Solution_> entityDescriptor,
                              Object entity)

Overrides:

beforeEntityAdded in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterEntityAdded

public void afterEntityAdded(EntityDescriptor<Solution_> entityDescriptor,
                             Object entity)

Overrides:

afterEntityAdded in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

beforeVariableChanged

public void beforeVariableChanged(VariableDescriptor variableDescriptor,
                                  Object entity)

Specified by:

beforeVariableChanged in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

beforeVariableChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterVariableChanged

public void afterVariableChanged(VariableDescriptor variableDescriptor,
                                 Object entity)

Specified by:

afterVariableChanged in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

afterVariableChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

beforeListVariableElementAssigned

public void beforeListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor,
                                              Object element)

Description copied from interface: InnerScoreDirector

Call this for each element that will be assigned (added to a list variable of one entity without being removed from a list variable of another entity).

Specified by:

beforeListVariableElementAssigned in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

beforeListVariableElementAssigned in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - the list variable descriptor

element - the assigned element

afterListVariableElementAssigned

public void afterListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor,
                                             Object element)

Description copied from interface: InnerScoreDirector

Call this for each element that was assigned (added to a list variable of one entity without being removed from a list variable of another entity).

Specified by:

afterListVariableElementAssigned in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

afterListVariableElementAssigned in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - the list variable descriptor

element - the assigned element

beforeListVariableElementUnassigned

public void beforeListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor,
                                                Object element)

Description copied from interface: InnerScoreDirector

Call this for each element that will be unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

beforeListVariableElementUnassigned in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

beforeListVariableElementUnassigned in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - the list variable descriptor

element - the unassigned element

afterListVariableElementUnassigned

public void afterListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor,
                                               Object element)

Description copied from interface: InnerScoreDirector

Call this for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

afterListVariableElementUnassigned in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

afterListVariableElementUnassigned in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - the list variable descriptor

element - the unassigned element

beforeListVariableChanged

public void beforeListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor,
                                      Object entity,
                                      int fromIndex,
                                      int toIndex)

Description copied from interface: InnerScoreDirector

Notify the score director before a list variable changes.

The list variable change includes:

• Changing position (index) of one or more elements.
• Removing one or more elements from the list variable.
• Adding one or more elements to the list variable.
• Any mix of the above.

For the sake of variable listeners' efficiency, the change notification requires an index range that contains elements affected by the change. The range starts at fromIndex (inclusive) and ends at toIndex (exclusive).

The range has to comply with the following contract:

1. fromIndex must be greater than or equal to 0; toIndex must be less than or equal to the list variable size.
2. toIndex must be greater than or equal to fromIndex.
3. The range must contain all elements that are going to be changed.
4. The range is allowed to contain elements that are not going to be changed.
5. The range may be empty (fromIndex equals toIndex) if none of the existing list variable elements are going to be changed.

InnerScoreDirector.beforeListVariableElementUnassigned(ListVariableDescriptor, Object) must be called for each element that will be unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

beforeListVariableChanged in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

beforeListVariableChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - descriptor of the list variable being changed

entity - the entity owning the list variable being changed

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

afterListVariableChanged

public void afterListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor,
                                     Object entity,
                                     int fromIndex,
                                     int toIndex)

Description copied from interface: InnerScoreDirector

Notify the score director after a list variable changes.

The list variable change includes:

• Changing position (index) of one or more elements.
• Removing one or more elements from the list variable.
• Adding one or more elements to the list variable.
• Any mix of the above.

For the sake of variable listeners' efficiency, the change notification requires an index range that contains elements affected by the change. The range starts at fromIndex (inclusive) and ends at toIndex (exclusive).

The range has to comply with the following contract:

1. fromIndex must be greater than or equal to 0; toIndex must be less than or equal to the list variable size.
2. toIndex must be greater than or equal to fromIndex.
3. The range must contain all elements that have changed.
4. The range is allowed to contain elements that have not changed.
5. The range may be empty (fromIndex equals toIndex) if none of the existing list variable elements have changed.

InnerScoreDirector.afterListVariableElementUnassigned(ListVariableDescriptor, Object) must be called for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

afterListVariableChanged in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

afterListVariableChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - descriptor of the list variable being changed

entity - the entity owning the list variable being changed

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

beforeEntityRemoved

public void beforeEntityRemoved(EntityDescriptor<Solution_> entityDescriptor,
                                Object entity)

Overrides:

beforeEntityRemoved in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterEntityRemoved

public void afterEntityRemoved(EntityDescriptor<Solution_> entityDescriptor,
                               Object entity)

Overrides:

afterEntityRemoved in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

beforeProblemFactAdded

public void beforeProblemFactAdded(Object problemFact)

Specified by:

beforeProblemFactAdded in interface ScoreDirector<Solution_>

Overrides:

beforeProblemFactAdded in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterProblemFactAdded

public void afterProblemFactAdded(Object problemFact)

Specified by:

afterProblemFactAdded in interface ScoreDirector<Solution_>

Overrides:

afterProblemFactAdded in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

beforeProblemPropertyChanged

public void beforeProblemPropertyChanged(Object problemFactOrEntity)

Specified by:

beforeProblemPropertyChanged in interface ScoreDirector<Solution_>

Overrides:

beforeProblemPropertyChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterProblemPropertyChanged

public void afterProblemPropertyChanged(Object problemFactOrEntity)

Specified by:

afterProblemPropertyChanged in interface ScoreDirector<Solution_>

Overrides:

afterProblemPropertyChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

beforeProblemFactRemoved

public void beforeProblemFactRemoved(Object problemFact)

Specified by:

beforeProblemFactRemoved in interface ScoreDirector<Solution_>

Overrides:

beforeProblemFactRemoved in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterProblemFactRemoved

public void afterProblemFactRemoved(Object problemFact)

Specified by:

afterProblemFactRemoved in interface ScoreDirector<Solution_>

Overrides:

afterProblemFactRemoved in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,IncrementalScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>