Package ai.timefold.solver.core.impl.move.streams.generic.move

Class ChainedChangeMove<Solution_,Entity_>

java.lang.Object

ai.timefold.solver.core.impl.move.streams.generic.move.AbstractMove<Solution_>

ai.timefold.solver.core.impl.move.streams.generic.move.ChangeMove<Solution_,Entity_,Entity_>

ai.timefold.solver.core.impl.move.streams.generic.move.ChainedChangeMove<Solution_,Entity_>

All Implemented Interfaces:

Move<Solution_>

public final class ChainedChangeMove<Solution_,Entity_>
extends ChangeMove<Solution_,Entity_,Entity_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.move.streams.generic.move.ChangeMove

entity, toPlanningValue, variableMetaModel

Constructor Summary

Constructors

Constructor	Description
ChainedChangeMove(PlanningVariableMetaModel<Solution_,Entity_,Entity_> variableMetaModel, Entity_ entity, Entity_ toPlanningValue, SingletonInverseVariableSupply inverseVariableSupply)

Method Summary

Modifier and Type	Method	Description
void	execute(@NonNull MutableSolutionView<Solution_> solutionView)	Runs the move and optionally records the changes done, so that they can be undone later.
@NonNull ChainedChangeMove<Solution_,Entity_>	rebase(@NonNull Rebaser rebaser)	Rebases a move from an origin ScoreDirector to another destination ScoreDirector which is usually on another Thread.

Methods inherited from class ai.timefold.solver.core.impl.move.streams.generic.move.ChangeMove

equals, extractPlanningEntities, extractPlanningValues, getVariableMetaModels, hashCode, readValue, toString

Methods inherited from class ai.timefold.solver.core.impl.move.streams.generic.move.AbstractMove

describe, getVariableDescriptor, getVariableDescriptor, getVariableDescriptor, rebaseList, rebaseSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChainedChangeMove

public ChainedChangeMove(PlanningVariableMetaModel<Solution_,Entity_,Entity_> variableMetaModel,
 Entity_ entity,
 Entity_ toPlanningValue,
 SingletonInverseVariableSupply inverseVariableSupply)

Method Details

execute

public void execute(@NonNull MutableSolutionView<Solution_> solutionView)

Description copied from interface: Move

Runs the move and optionally records the changes done, so that they can be undone later.

Specified by:

execute in interface Move<Solution_>

Overrides:

execute in class ChangeMove<Solution_,Entity_,Entity_>

Parameters:

solutionView - Exposes all possible mutative operations on the variables. Remembers those mutative operations and can replay them in reverse order when the solver needs to undo the move. Do not store this parameter in a field.

rebase

public @NonNull ChainedChangeMove<Solution_,Entity_> rebase(@NonNull Rebaser rebaser)

Description copied from interface: Move

Rebases a move from an origin ScoreDirector to another destination ScoreDirector which is usually on another Thread. It is necessary for multithreaded solving to function.

The new move returned by this method translates the entities and problem facts to the destination PlanningSolution of the destination ScoreDirector, That destination PlanningSolution is a deep planning clone (or an even deeper clone) of the origin PlanningSolution that this move has been generated from.

That new move does the exact same change as this move, resulting in the same PlanningSolution state, presuming that destination PlanningSolution was in the same state as the original PlanningSolution to begin with.

An implementation of this method typically iterates through every entity and fact instance in this move, translates each one to the destination ScoreDirector with Rebaser.rebase(Object) and creates a new move instance of the same move type, using those translated instances.

The destination PlanningSolution can be in a different state than the original PlanningSolution. So, rebasing can only depend on the identity of planning entities and problem facts, which are usually declared by a PlanningId on those classes. It must not depend on the state of the planning variables. One thread might rebase a move before, amid or after another thread does that same move instance.

This method is thread-safe.

Specified by:

rebase in interface Move<Solution_>

Overrides:

rebase in class ChangeMove<Solution_,Entity_,Entity_>

Parameters:

rebaser - Do not store this parameter in a field

Returns:

New move that does the same change as this move on another solution instance