org.optaplanner.core.impl.score.director.stream

Class ConstraintStreamScoreDirector<Solution_>

java.lang.Object

org.optaplanner.core.impl.score.director.AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

org.optaplanner.core.impl.score.director.stream.ConstraintStreamScoreDirector<Solution_>

Type Parameters:

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

All Implemented Interfaces:

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

public class ConstraintStreamScoreDirector<Solution_>
extends AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

FP streams 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

Modifier and Type	Field and Description
protected ConstraintSession<Solution_>	session

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 and Description
ConstraintStreamScoreDirector(ConstraintStreamScoreDirectorFactory<Solution_> scoreDirectorFactory, boolean lookUpEnabled, boolean constraintMatchEnabledPreference)

Method Summary

Modifier and Type	Method and Description
void	afterEntityAdded(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	afterEntityRemoved(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	afterProblemFactAdded(Object problemFact)
void	afterProblemFactRemoved(Object problemFact)
void	afterProblemPropertyChanged(Object problemFactOrEntity)
void	afterVariableChanged(VariableDescriptor variableDescriptor, Object entity)
Score	calculateScore() Calculates the Score and updates the working solution accordingly.
void	close() Needs to be called after use because some implementations need to clean up their resources.
Map<String,ConstraintMatchTotal>	getConstraintMatchTotalMap() Explains the Score of ScoreDirector.calculateScore() by splitting it up per constraint type (which is usually a score rule).
Collection<ConstraintMatchTotal>	getConstraintMatchTotals() Explains the Score of ScoreDirector.calculateScore() by splitting it up per constraint type (which is usually a score rule).
Map<Object,Indictment>	getIndictmentMap() Explains the impact of each planning entity or problem fact on the Score.
boolean	isConstraintMatchEnabled()
void	setWorkingSolution(Solution_ workingSolution) The working solution must never be the same instance as the best solution, it should be a (un)changed clone.

Methods inherited from class org.optaplanner.core.impl.score.director.AbstractScoreDirector

afterEntityAdded, afterEntityRemoved, afterVariableChanged, assertExpectedUndoMoveScore, assertExpectedWorkingScore, assertPredictedScoreFromScratch, assertShadowVariablesAreNotStale, assertWorkingScoreFromScratch, beforeEntityAdded, beforeEntityAdded, beforeEntityRemoved, beforeEntityRemoved, beforeProblemFactAdded, beforeProblemFactRemoved, beforeProblemPropertyChanged, beforeVariableChanged, beforeVariableChanged, buildScoreCorruptionAnalysis, buildShadowVariableAnalysis, changeVariableFacade, clone, cloneSolution, cloneWorkingSolution, 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

Field Detail

session

protected ConstraintSession<Solution_> session

Constructor Detail

ConstraintStreamScoreDirector

public ConstraintStreamScoreDirector(ConstraintStreamScoreDirectorFactory<Solution_> scoreDirectorFactory,
                                     boolean lookUpEnabled,
                                     boolean constraintMatchEnabledPreference)

Method Detail

setWorkingSolution

public void setWorkingSolution(Solution_ workingSolution)

Description copied from interface: ScoreDirector

The working solution must never be the same instance as the best solution, it should be a (un)changed clone.

Only call this method on a separate ScoreDirector instance, built by SolverFactory.getScoreDirectorFactory(), not on the one used inside the Solver itself.

Specified by:

setWorkingSolution in interface ScoreDirector<Solution_>

Overrides:

setWorkingSolution in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

Parameters:

workingSolution - never null

calculateScore

public Score calculateScore()

Description copied from interface: ScoreDirector

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 ScoreDirector.getConstraintMatchTotals(), ScoreDirector.getConstraintMatchTotalMap() and ScoreDirector.getIndictmentMap() can be called

getConstraintMatchTotals

public Collection<ConstraintMatchTotal> getConstraintMatchTotals()

Description copied from interface: ScoreDirector

Explains the Score of ScoreDirector.calculateScore() by splitting it up per constraint type (which is usually a score rule).

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

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

Returns:

never null

See Also:

ScoreDirector.getConstraintMatchTotalMap(), ScoreDirector.getIndictmentMap()

getConstraintMatchTotalMap

public Map<String,ConstraintMatchTotal> getConstraintMatchTotalMap()

Description copied from interface: ScoreDirector

Explains the Score of ScoreDirector.calculateScore() by splitting it up per constraint type (which is usually a score rule).

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

Call ScoreDirector.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:

ScoreDirector.getIndictmentMap()

getIndictmentMap

public Map<Object,Indictment> getIndictmentMap()

Description copied from interface: ScoreDirector

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 justification Object in ConstraintMatch.getJustificationList().

Warning: In practice, it often doesn't include the full impact on the Score, for example in DRL score rules with accumulate, the accumulate elements won't be indicted.

The sum of ConstraintMatchTotal.getScore() differs from ScoreDirector.calculateScore() because each ConstraintMatch.getScore() is counted for each justification in ConstraintMatch.getJustificationList().

Call ScoreDirector.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:

ScoreDirector.getConstraintMatchTotalMap()

close

public void close()

Description copied from interface: ScoreDirector

Needs to be called after use because some implementations need to clean up their resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ScoreDirector<Solution_>

Overrides:

close in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

afterEntityAdded

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

Overrides:

afterEntityAdded in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

afterVariableChanged

public void afterVariableChanged(VariableDescriptor variableDescriptor,
                                 Object entity)

Specified by:

afterVariableChanged in interface ScoreDirector<Solution_>

Overrides:

afterVariableChanged in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

afterEntityRemoved

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

Overrides:

afterEntityRemoved in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

afterProblemFactAdded

public void afterProblemFactAdded(Object problemFact)

Specified by:

afterProblemFactAdded in interface ScoreDirector<Solution_>

Overrides:

afterProblemFactAdded in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

afterProblemPropertyChanged

public void afterProblemPropertyChanged(Object problemFactOrEntity)

Specified by:

afterProblemPropertyChanged in interface ScoreDirector<Solution_>

Overrides:

afterProblemPropertyChanged in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>

afterProblemFactRemoved

public void afterProblemFactRemoved(Object problemFact)

Specified by:

afterProblemFactRemoved in interface ScoreDirector<Solution_>

Overrides:

afterProblemFactRemoved in class AbstractScoreDirector<Solution_,ConstraintStreamScoreDirectorFactory<Solution_>>