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

Class MoveDirector<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.move.director.MoveDirector<Solution_>

All Implemented Interfaces:

InnerMutableSolutionView<Solution_>, MutableSolutionView<Solution_>, Rebaser, SolutionView<Solution_>

Direct Known Subclasses:

EphemeralMoveDirector

public sealed class MoveDirector<Solution_>
extends Object
implements InnerMutableSolutionView<Solution_>, Rebaser
permits EphemeralMoveDirector<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected final VariableDescriptorAwareScoreDirector<Solution_>	scoreDirector

Constructor Summary

Constructors

Constructor	Description
MoveDirector(VariableDescriptorAwareScoreDirector<Solution_> scoreDirector)

Method Summary

Modifier and Type	Method	Description
final <Entity_, Value_> void	changeVariable(@NonNull PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @NonNull Entity_ entity, Value_ newValue)	Reads the value of a @basic planning variable of a given entity.
EphemeralMoveDirector<Solution_>	ephemeral()	Moves that are to be undone later need to be run with the instance returned by this method.
<Entity_, Value_> @NonNull ElementLocation	getPositionOf(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @NonNull Value_ value)	Locates a given value in any @list planning variable.
protected static <Solution_, Entity_, Value_> ElementLocation	getPositionOf(InnerScoreDirector<Solution_,?> scoreDirector, PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)
VariableDescriptorAwareScoreDirector<Solution_>	getScoreDirector()
final <Entity_, Value_> Value_	getValue(@NonNull PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @NonNull Entity_ entity)	Reads the value of a @basic planning variable of a given entity.
final <Entity_, Value_> Value_	getValueAtIndex(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @NonNull Entity_ entity, int index)	Reads the value of a @list planning variable of a given entity at a specific index.
final <Entity_, Value_> void	moveValueBetweenLists(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @NonNull Entity_ sourceEntity, int sourceIndex, @NonNull Entity_ destinationEntity, int destinationIndex)	Moves a value from one entity's planning list variable to another.
final <Entity_, Value_> void	moveValueInList(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @NonNull Entity_ entity, int sourceIndex, int destinationIndex)	Moves a value within one entity's planning list variable.
final <T> T	rebase(@NonNull T problemFactOrPlanningEntity)	Translates an entity or fact instance (often from another Thread) to another ScoreDirector's internal working instance.
final void	updateShadowVariables()	Tells the underlying ScoreDirector to notify the solver of the mutating operations performed by the Move.

Methods inherited from class java.lang.Object

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

Field Details

scoreDirector

protected final VariableDescriptorAwareScoreDirector<Solution_> scoreDirector

Constructor Details

MoveDirector

public MoveDirector(VariableDescriptorAwareScoreDirector<Solution_> scoreDirector)

Method Details

changeVariable

public final <Entity_,
Value_> void changeVariable(@NonNull PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 @NonNull Entity_ entity,
 Value_ newValue)

Description copied from interface: MutableSolutionView

Reads the value of a @basic planning variable of a given entity.

Specified by:

changeVariable in interface MutableSolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable to be changed.

entity - The entity whose variable value is to be changed.

newValue - maybe null, if unassigning the variable

moveValueBetweenLists

public final <Entity_,
Value_> void moveValueBetweenLists(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 @NonNull Entity_ sourceEntity,
 int sourceIndex,
 @NonNull Entity_ destinationEntity,
 int destinationIndex)

Description copied from interface: MutableSolutionView

Moves a value from one entity's planning list variable to another.

Specified by:

moveValueBetweenLists in interface MutableSolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable to be changed.

sourceEntity - The first entity whose variable value is to be changed.

sourceIndex - >= 0

destinationEntity - The second entity whose variable value is to be changed.

destinationIndex - >= 0

moveValueInList

public final <Entity_,
Value_> void moveValueInList(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 @NonNull Entity_ entity,
 int sourceIndex,
 int destinationIndex)

Description copied from interface: MutableSolutionView

Moves a value within one entity's planning list variable.

Specified by:

moveValueInList in interface MutableSolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable to be changed.

entity - The entity whose variable value is to be changed.

sourceIndex - >= 0

destinationIndex - >= 0

updateShadowVariables

public final void updateShadowVariables()

Description copied from interface: MutableSolutionView

Tells the underlying ScoreDirector to notify the solver of the mutating operations performed by the Move.

Specified by:

updateShadowVariables in interface MutableSolutionView<Solution_>

getValue

public final <Entity_,
Value_> Value_ getValue(@NonNull PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 @NonNull Entity_ entity)

Description copied from interface: SolutionView

Reads the value of a @basic planning variable of a given entity.

Specified by:

getValue in interface SolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable whose value is to be read.

entity - The entity whose variable is to be read.

Returns:

The value of the variable on the entity.

getValueAtIndex

public final <Entity_,
Value_> Value_ getValueAtIndex(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 @NonNull Entity_ entity,
 int index)

Description copied from interface: SolutionView

Reads the value of a @list planning variable of a given entity at a specific index.

Specified by:

getValueAtIndex in interface SolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable whose value is to be read.

entity - The entity whose variable is to be read.

index - >= 0

Returns:

maybe null; the value of the variable on the entity at the index

getPositionOf

public <Entity_,
Value_> @NonNull ElementLocation getPositionOf(@NonNull PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 @NonNull Value_ value)

Description copied from interface: SolutionView

Locates a given value in any @list planning variable.

Specified by:

getPositionOf in interface SolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable whose value is to be read.

value - The value to locate.

Returns:

never null; the location of the value in the variable

getPositionOf

protected static <Solution_,
Entity_,
Value_>
ElementLocation getPositionOf(InnerScoreDirector<Solution_,?> scoreDirector,
 PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 Value_ value)

rebase

public final <T> T rebase(@NonNull T problemFactOrPlanningEntity)

Description copied from interface: Rebaser

Translates an entity or fact instance (often from another Thread) to another ScoreDirector's internal working instance. Useful for move rebasing and in a ProblemChange and for multi-threaded solving.

Matching is determined by the LookUpStrategyType on PlanningSolution. Matching uses a PlanningId by default.

Specified by:

rebase in interface Rebaser

Parameters:

problemFactOrPlanningEntity - The fact or entity to rebase.

Returns:

null if externalObject is null

ephemeral

public EphemeralMoveDirector<Solution_> ephemeral()

Moves that are to be undone later need to be run with the instance returned by this method.

Returns:

never null

getScoreDirector

public VariableDescriptorAwareScoreDirector<Solution_> getScoreDirector()

Specified by:

getScoreDirector in interface InnerMutableSolutionView<Solution_>