Package ai.timefold.solver.core.api.score.calculator

Interface ConstraintMatchAwareIncrementalScoreCalculator<Solution_,Score_ extends Score<Score_>>

Type Parameters:

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

Score_ - the Score type

All Superinterfaces:

IncrementalScoreCalculator<Solution_,Score_>

public interface ConstraintMatchAwareIncrementalScoreCalculator<Solution_,Score_ extends Score<Score_>>
extends IncrementalScoreCalculator<Solution_,Score_>

Allows a IncrementalScoreCalculator to report ConstraintMatchTotals for explaining a score (= which score constraints match for how much) and also for score corruption analysis.

Method Summary

Modifier and Type	Method	Description
@NonNull Collection<ConstraintMatchTotal<Score_>>	getConstraintMatchTotals()
@Nullable Map<Object,Indictment<Score_>>	getIndictmentMap()
void	resetWorkingSolution(@NonNull Solution_ workingSolution, boolean constraintMatchEnabled)	Allows for increased performance because it only tracks if constraintMatchEnabled is true.

Methods inherited from interface ai.timefold.solver.core.api.score.calculator.IncrementalScoreCalculator

afterEntityAdded, afterEntityRemoved, afterListVariableChanged, afterListVariableElementAssigned, afterListVariableElementUnassigned, afterVariableChanged, beforeEntityAdded, beforeEntityRemoved, beforeListVariableChanged, beforeListVariableElementAssigned, beforeListVariableElementUnassigned, beforeVariableChanged, calculateScore, resetWorkingSolution

Method Details

resetWorkingSolution

void resetWorkingSolution(@NonNull Solution_ workingSolution,
 boolean constraintMatchEnabled)

Allows for increased performance because it only tracks if constraintMatchEnabled is true.

Every implementation should call resetWorkingSolution(Solution_, boolean) and only handle the constraintMatchEnabled parameter specifically (or ignore it).

Parameters:

workingSolution - to pass to resetWorkingSolution(Solution_, boolean).

constraintMatchEnabled - true if getConstraintMatchTotals() or getIndictmentMap() might be called.

getConstraintMatchTotals

@NonNull Collection<ConstraintMatchTotal<Score_>> getConstraintMatchTotals()

Returns:

never null; if a constraint is present in the problem but resulted in no matches, it should still be present with a ConstraintMatchTotal.getConstraintMatchSet() size of 0.

Throws:

IllegalStateException - if resetWorkingSolution(Solution_, boolean)'s constraintMatchEnabled parameter was false

getIndictmentMap

@Nullable Map<Object,Indictment<Score_>> getIndictmentMap()

Returns:

null if it should to be calculated non-incrementally from getConstraintMatchTotals()

Throws:

IllegalStateException - if resetWorkingSolution(Solution_, boolean)'s constraintMatchEnabled parameter was false

See Also:

• ScoreExplanation.getIndictmentMap()