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

Class AbstractScoreDirectorFactory<Solution_,Score_ extends Score<Score_>,Factory_ extends AbstractScoreDirectorFactory<Solution_,Score_,Factory_>>

java.lang.Object

ai.timefold.solver.core.impl.score.director.AbstractScoreDirectorFactory<Solution_,Score_,Factory_>

Type Parameters:

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

Score_ - the score type to go with the solution

All Implemented Interfaces:

ScoreDirectorFactory<Solution_,Score_>

Direct Known Subclasses:

AbstractConstraintStreamScoreDirectorFactory, EasyScoreDirectorFactory, IncrementalScoreDirectorFactory

public abstract class AbstractScoreDirectorFactory<Solution_,Score_ extends Score<Score_>,Factory_ extends AbstractScoreDirectorFactory<Solution_,Score_,Factory_>>
extends Object
implements ScoreDirectorFactory<Solution_,Score_>

Abstract superclass for ScoreDirectorFactory.

See Also:

• ScoreDirectorFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	assertClonedSolution
protected ScoreDirectorFactory<Solution_,Score_>	assertionScoreDirectorFactory
protected InitializingScoreTrend	initializingScoreTrend
protected final ListVariableDescriptor<Solution_>	listVariableDescriptor
protected final org.slf4j.Logger	logger
protected final SolutionDescriptor<Solution_>	solutionDescriptor
protected boolean	trackingWorkingSolution

Constructor Summary

Constructors

Constructor	Description
AbstractScoreDirectorFactory(SolutionDescriptor<Solution_> solutionDescriptor)

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.
ScoreDirectorFactory<Solution_,Score_>	getAssertionScoreDirectorFactory()
InitializingScoreTrend	getInitializingScoreTrend()
ScoreDefinition<Score_>	getScoreDefinition()
SolutionDescriptor<Solution_>	getSolutionDescriptor()
boolean	isAssertClonedSolution()
boolean	isTrackingWorkingSolution()	When true, a snapshot of the solution is created before, after and after the undo of a move.
void	setAssertClonedSolution(boolean assertClonedSolution)
void	setAssertionScoreDirectorFactory(ScoreDirectorFactory<Solution_,Score_> assertionScoreDirectorFactory)
void	setInitializingScoreTrend(InitializingScoreTrend initializingScoreTrend)
void	setTrackingWorkingSolution(boolean trackingWorkingSolution)
void	validateEntity(ScoreDirector<Solution_> scoreDirector, Object entity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ai.timefold.solver.core.impl.score.director.ScoreDirectorFactory

buildScoreDirector, createScoreDirectorBuilder, supportsConstraintMatching

Field Details

logger

protected final transient org.slf4j.Logger logger

solutionDescriptor

protected final SolutionDescriptor<Solution_> solutionDescriptor

listVariableDescriptor

protected final ListVariableDescriptor<Solution_> listVariableDescriptor

initializingScoreTrend

protected InitializingScoreTrend initializingScoreTrend

assertionScoreDirectorFactory

protected ScoreDirectorFactory<Solution_,Score_ extends Score<Score_>> assertionScoreDirectorFactory

assertClonedSolution

protected boolean assertClonedSolution

trackingWorkingSolution

protected boolean trackingWorkingSolution

Constructor Details

AbstractScoreDirectorFactory

public AbstractScoreDirectorFactory(SolutionDescriptor<Solution_> solutionDescriptor)

Method Details

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()

Specified by:

getSolutionDescriptor in interface ScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>

Returns:

never null

getScoreDefinition

public ScoreDefinition<Score_> getScoreDefinition()

Specified by:

getScoreDefinition in interface ScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>

Returns:

never null

getInitializingScoreTrend

public InitializingScoreTrend getInitializingScoreTrend()

Specified by:

getInitializingScoreTrend in interface ScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>

Returns:

never null

setInitializingScoreTrend

public void setInitializingScoreTrend(InitializingScoreTrend initializingScoreTrend)

getAssertionScoreDirectorFactory

public ScoreDirectorFactory<Solution_,Score_> getAssertionScoreDirectorFactory()

setAssertionScoreDirectorFactory

public void setAssertionScoreDirectorFactory(ScoreDirectorFactory<Solution_,Score_> assertionScoreDirectorFactory)

isAssertClonedSolution

public boolean isAssertClonedSolution()

setAssertClonedSolution

public void setAssertClonedSolution(boolean assertClonedSolution)

isTrackingWorkingSolution

public boolean isTrackingWorkingSolution()

When true, a snapshot of the solution is created before, after and after the undo of a move. In EnvironmentMode.TRACKED_FULL_ASSERT, the snapshots are compared when corruption is detected, allowing us to report exactly what variables are different.

setTrackingWorkingSolution

public void setTrackingWorkingSolution(boolean trackingWorkingSolution)

assertScoreFromScratch

public void assertScoreFromScratch(Solution_ solution)

Description copied from interface: ScoreDirectorFactory

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

Specified by:

assertScoreFromScratch in interface ScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>

Parameters:

solution - never null

See Also:

• InnerScoreDirector.assertWorkingScoreFromScratch(InnerScore, Object)

validateEntity

public void validateEntity(ScoreDirector<Solution_> scoreDirector,
 Object entity)