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

Class MoveDirector<Solution_,Score_ extends Score<Score_>>

java.lang.Object

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

All Implemented Interfaces:

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

@NullMarked
public sealed class MoveDirector<Solution_,Score_ extends Score<Score_>>
extends Object
implements InnerMutableSolutionView<Solution_>, Rebaser

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MoveDirector.TemporaryMovePostprocessor<Solution_,Score_ extends Score<Score_>,Result_>	Allows for reading data produced by a temporary move, before it is undone.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
MoveDirector(InnerScoreDirector<Solution_,Score_> scoreDirector)

Method Summary

Modifier and Type	Method	Description
final <Entity_, Value_> void	assignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ planningValue, Entity_ destinationEntity, int destinationIndex)	Puts a given value at a particular index in a given entity's planning list variable.
final <Entity_, Value_> void	changeVariable(PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, @Nullable Value_ newValue)	Reads the value of a @basic planning variable of a given entity.
final void	execute(Move<Solution_> move)
final void	execute(Move<Solution_> move)	Execute a given move and make sure shadow variables are up to date after that.
final <Result_> Result_	executeTemporary(Move<Solution_> move, MoveDirector.TemporaryMovePostprocessor<Solution_,Score_,Result_> postprocessor)
final InnerScore<Score_>	executeTemporary(Move<Solution_> move)
<Result_> Result_	executeTemporary(Move<Solution_> move, MoveDirector.TemporaryMovePostprocessor<Solution_,Score_,Result_> postprocessor)
protected static <Solution_, Entity_, Value_> ElementPosition	getPositionOf(InnerScoreDirector<Solution_,?> scoreDirector, PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)
<Entity_, Value_> ElementPosition	getPositionOf(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)	Locates a given value in any @list planning variable.
final VariableDescriptorAwareScoreDirector<Solution_>	getScoreDirector()
final <Entity_, Value_> Value_	getValue(PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity)	Reads the value of a @basic planning variable of a given entity.
final <Entity_, Value_> Value_	getValueAtIndex(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int index)	Reads the value of a @list planning variable of a given entity at a specific index.
final <Entity_, Value_> @Nullable Value_	moveValueBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, Entity_ destinationEntity, int destinationIndex)	Moves a value from one entity's planning list variable to another.
final <Entity_, Value_> @Nullable Value_	moveValueInList(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int sourceIndex, int destinationIndex)	Moves a value within one entity's planning list variable.
final <T> @Nullable T	rebase(@Nullable T problemFactOrPlanningEntity)	Translates an entity or fact instance (often from another Thread) to another ScoreDirector's internal working instance.
final <Entity_, Value_> void	unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ movedValue, Entity_ sourceEntity, int sourceIndex)	Removes a given value from a given entity's planning list variable at a given index.

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.preview.api.move.MutableSolutionView

unassignValue, unassignValue

Field Details

externalScoreDirector

protected final VariableDescriptorAwareScoreDirector<Solution_> externalScoreDirector

Constructor Details

MoveDirector

public MoveDirector(InnerScoreDirector<Solution_,Score_> scoreDirector)

Method Details

assignValue

public final <Entity_,
Value_> void assignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 Value_ planningValue,
 Entity_ destinationEntity,
 int destinationIndex)

Description copied from interface: MutableSolutionView

Puts a given value at a particular index in a given entity's planning list variable. Moves all values at or after the index to the right.

Specified by:

assignValue in interface MutableSolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable to be changed.

planningValue - The value to be assigned to a list variable.

destinationEntity - The entity whose list variable is to be changed.

destinationIndex - The index at which the value is to be assigned.

unassignValue

public final <Entity_,
Value_> void unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 Value_ movedValue,
 Entity_ sourceEntity,
 int sourceIndex)

Description copied from interface: MutableSolutionView

Removes a given value from a given entity's planning list variable at a given index. Shifts any later values to the left.

Specified by:

unassignValue in interface MutableSolutionView<Solution_>

Parameters:

variableMetaModel - Describes the variable to be changed.

movedValue - The value to be unassigned from a list variable.

sourceEntity - The entity whose value is to be unassigned from a list variable.

sourceIndex - >= 0

changeVariable

public final <Entity_,
Value_> void changeVariable(PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 Entity_ entity,
 @Nullable 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_> @Nullable Value_ moveValueBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 Entity_ sourceEntity,
 int sourceIndex,
 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

Returns:

the value that was moved; null if nothing was moved

moveValueInList

public final <Entity_,
Value_> @Nullable Value_ moveValueInList(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 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

Returns:

the value that was moved; null if nothing was moved

execute

public final void execute(Move<Solution_> move)

Execute a given move and make sure shadow variables are up to date after that.

execute

public final void execute(Move<Solution_> move)

executeTemporary

public final InnerScore<Score_> executeTemporary(Move<Solution_> move)

executeTemporary

public <Result_> Result_ executeTemporary(Move<Solution_> move,
 MoveDirector.TemporaryMovePostprocessor<Solution_,Score_,Result_> postprocessor)

executeTemporary

public final <Result_> Result_ executeTemporary(Move<Solution_> move,
 MoveDirector.TemporaryMovePostprocessor<Solution_,Score_,Result_> postprocessor)

getValue

public final <Entity_,
Value_> Value_ getValue(PlanningVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 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(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 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:

The value at the given index in the list variable.

getPositionOf

public <Entity_,
Value_> ElementPosition getPositionOf(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel,
 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:

the location of the value in the variable

getPositionOf

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

rebase

public final <T> @Nullable T rebase(@Nullable 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 problemFactOrPlanningEntity is null

getScoreDirector

public final VariableDescriptorAwareScoreDirector<Solution_> getScoreDirector()

Specified by:

getScoreDirector in interface InnerMutableSolutionView<Solution_>