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

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

Type Parameters:

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

Score_ - the score type to go with the solution

All Superinterfaces:

ScoreDirectorFactory<Solution_>

All Known Implementing Classes:

AbstractConstraintStreamScoreDirectorFactory, AbstractScoreDirectorFactory, BavetConstraintStreamScoreDirectorFactory, EasyScoreDirectorFactory, IncrementalScoreDirectorFactory

public interface InnerScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>
extends ScoreDirectorFactory<Solution_>

Method Summary

Modifier and Type	Method	Description
void	assertScoreFromScratch(Solution_ solution)	Asserts that if the Score is calculated for the parameter solution, it would be equal to the score of that parameter.
default InnerScoreDirector<Solution_,Score_>	buildDerivedScoreDirector(boolean lookUpEnabled, boolean constraintMatchEnabledPreference)	Like buildScoreDirector(boolean, boolean), but makes the score director a derived one.
InnerScoreDirector<Solution_,Score_>	buildScoreDirector()	Creates a new ScoreDirector instance.
default InnerScoreDirector<Solution_,Score_>	buildScoreDirector(boolean lookUpEnabled, boolean constraintMatchEnabledPreference)	Like buildScoreDirector(), but optionally disables ConstraintMatch tracking and look up for more performance (presuming the ScoreDirector implementation actually supports it to begin with).
InnerScoreDirector<Solution_,Score_>	buildScoreDirector(boolean lookUpEnabled, boolean constraintMatchEnabledPreference, boolean expectShadowVariablesInCorrectState)	Like buildScoreDirector(), but optionally disables ConstraintMatch tracking and look up for more performance (presuming the ScoreDirector implementation actually supports it to begin with).
InitializingScoreTrend	getInitializingScoreTrend()
ScoreDefinition<Score_>	getScoreDefinition()
SolutionDescriptor<Solution_>	getSolutionDescriptor()
default boolean	supportsConstraintMatching()

Method Details

getSolutionDescriptor

SolutionDescriptor<Solution_> getSolutionDescriptor()

Returns:

never null

getScoreDefinition

ScoreDefinition<Score_> getScoreDefinition()

Returns:

never null

buildScoreDirector

InnerScoreDirector<Solution_,Score_> buildScoreDirector()

Description copied from interface: ScoreDirectorFactory

Creates a new ScoreDirector instance.

Specified by:

buildScoreDirector in interface ScoreDirectorFactory<Solution_>

Returns:

never null

buildScoreDirector

default InnerScoreDirector<Solution_,Score_> buildScoreDirector(boolean lookUpEnabled,
 boolean constraintMatchEnabledPreference)

Like buildScoreDirector(), but optionally disables ConstraintMatch tracking and look up for more performance (presuming the ScoreDirector implementation actually supports it to begin with).

Parameters:

lookUpEnabled - true if a ScoreDirector implementation should track all working objects for ScoreDirector.lookUpWorkingObject(Object)

constraintMatchEnabledPreference - false if a ScoreDirector implementation should not do ConstraintMatch tracking even if it supports it.

Returns:

never null

See Also:

• InnerScoreDirector.isConstraintMatchEnabled()
• InnerScoreDirector.getConstraintMatchTotalMap()

buildScoreDirector

InnerScoreDirector<Solution_,Score_> buildScoreDirector(boolean lookUpEnabled,
 boolean constraintMatchEnabledPreference,
 boolean expectShadowVariablesInCorrectState)

Like buildScoreDirector(), but optionally disables ConstraintMatch tracking and look up for more performance (presuming the ScoreDirector implementation actually supports it to begin with).

Parameters:

lookUpEnabled - true if a ScoreDirector implementation should track all working objects for ScoreDirector.lookUpWorkingObject(Object)

constraintMatchEnabledPreference - false if a ScoreDirector implementation should not do ConstraintMatch tracking even if it supports it.

expectShadowVariablesInCorrectState - true, unless you have an exceptional reason. See InnerScoreDirector.expectShadowVariablesInCorrectState() for details.

Returns:

never null

See Also:

• InnerScoreDirector.isConstraintMatchEnabled()
• InnerScoreDirector.getConstraintMatchTotalMap()

buildDerivedScoreDirector

default InnerScoreDirector<Solution_,Score_> buildDerivedScoreDirector(boolean lookUpEnabled,
 boolean constraintMatchEnabledPreference)

Like buildScoreDirector(boolean, boolean), but makes the score director a derived one. Derived score directors may make choices which the main score director can not make, such as reducing logging. Derived score directors are typically used for multithreaded solving, testing and assert modes.

Parameters:

lookUpEnabled - true if a ScoreDirector implementation should track all working objects for ScoreDirector.lookUpWorkingObject(Object)

constraintMatchEnabledPreference - false if a ScoreDirector implementation should not do ConstraintMatch tracking even if it supports it.

Returns:

never null

See Also:

• InnerScoreDirector.isConstraintMatchEnabled()
• InnerScoreDirector.getConstraintMatchTotalMap()

getInitializingScoreTrend

InitializingScoreTrend getInitializingScoreTrend()

Returns:

never null

assertScoreFromScratch

void assertScoreFromScratch(Solution_ solution)

Asserts that if the Score is calculated for the parameter solution, it would be equal to the score of that parameter.

Parameters:

solution - never null

See Also:

• InnerScoreDirector.assertWorkingScoreFromScratch(Score, Object)

supportsConstraintMatching

default boolean supportsConstraintMatching()