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

Class AbstractMove<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.heuristic.move.AbstractMove<Solution_>

Type Parameters:

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

All Implemented Interfaces:

Move<Solution_>, Move<Solution_>

Direct Known Subclasses:

ChangeMove, CompositeMove, KOptListMove, KOptMove, ListAssignMove, ListChangeMove, ListRuinRecreateMove, ListSwapMove, ListUnassignMove, NoChangeMove, PillarChangeMove, PillarSwapMove, RuinRecreateMove, SubChainChangeMove, SubChainReversingChangeMove, SubChainReversingSwapMove, SubChainSwapMove, SubListChangeMove, SubListSwapMove, SubListUnassignMove, SwapMove, TailChainSwapMove, TwoOptListMove

public abstract class AbstractMove<Solution_>
extends Object
implements Move<Solution_>

Abstract superclass for Move, requiring implementation of undo moves.

See Also:

• Move

Constructor Summary

Constructors

Constructor	Description
AbstractMove()

Method Summary

Modifier and Type	Method	Description
protected Move<Solution_>	createUndoMove(ScoreDirector<Solution_> scoreDirector)	Deprecated, for removal: This API element is subject to removal in a future version. The solver automatically generates undo moves, this method is no longer used.
final String	describe()	Do not override this default implementation.
protected abstract void	doMoveOnGenuineVariables(ScoreDirector<Solution_> scoreDirector)	Like doMoveOnly(ScoreDirector) but without the ScoreDirector.triggerVariableListeners() call (because doMoveOnly(ScoreDirector) already does that).
final void	doMoveOnly(ScoreDirector<Solution_> scoreDirector)	Does the move (which indirectly affects the ScoreDirector.getWorkingSolution()).
final void	execute(MutableSolutionView<Solution_> solutionView)	Do not override this default implementation.
protected <Value_> ValueRange<Value_>	extractValueRangeFromEntity(ScoreDirector<Solution_> scoreDirector, ValueRangeDescriptor<Solution_> valueRangeDescriptor, Object entity)
final Move<Solution_>	rebase(Rebaser rebaser)	Do not override this default implementation.
static <E> List<E>	rebaseList(List<E> externalObjectList, ScoreDirector<?> destinationScoreDirector)
static <E> Set<E>	rebaseSet(Set<E> externalObjectSet, ScoreDirector<?> destinationScoreDirector)

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.heuristic.move.Move

doMove, getSimpleMoveTypeDescription, isMoveDoable, rebase

Methods inherited from interface ai.timefold.solver.core.preview.api.move.Move

getPlanningEntities, getPlanningValues

Constructor Details

AbstractMove

public AbstractMove()

Method Details

doMoveOnly

public final void doMoveOnly(ScoreDirector<Solution_> scoreDirector)

Description copied from interface: Move

Does the move (which indirectly affects the ScoreDirector.getWorkingSolution()). When the working solution is modified, the ScoreDirector must be correctly notified (through ScoreDirector.beforeVariableChanged(Object, String) and ScoreDirector.afterVariableChanged(Object, String)), otherwise later calculated Scores will be corrupted, or the move may not be correctly undone.

This method must end with calling ScoreDirector.triggerVariableListeners() to ensure all shadow variables are updated.

Specified by:

doMoveOnly in interface Move<Solution_>

Parameters:

scoreDirector - never null, the ScoreDirector that needs to get notified of the changes

createUndoMove

@Deprecated(forRemoval=true,
            since="1.16.0")
protected Move<Solution_> createUndoMove(ScoreDirector<Solution_> scoreDirector)

Deprecated, for removal: This API element is subject to removal in a future version.

The solver automatically generates undo moves, this method is no longer used.

Called before the move is done, so the move can be evaluated and then be undone without resulting into a permanent change in the solution.

Parameters:

scoreDirector - the ScoreDirector not yet modified by the move.

Returns:

an undoMove which does the exact opposite of this move.

doMoveOnGenuineVariables

protected abstract void doMoveOnGenuineVariables(ScoreDirector<Solution_> scoreDirector)

Like doMoveOnly(ScoreDirector) but without the ScoreDirector.triggerVariableListeners() call (because doMoveOnly(ScoreDirector) already does that).

Parameters:

scoreDirector - never null

extractValueRangeFromEntity

protected <Value_> ValueRange<Value_> extractValueRangeFromEntity(ScoreDirector<Solution_> scoreDirector,
 ValueRangeDescriptor<Solution_> valueRangeDescriptor,
 Object entity)

rebaseList

public static <E> List<E> rebaseList(List<E> externalObjectList,
 ScoreDirector<?> destinationScoreDirector)

rebaseSet

public static <E> Set<E> rebaseSet(Set<E> externalObjectSet,
 ScoreDirector<?> destinationScoreDirector)

execute

public final void execute(MutableSolutionView<Solution_> solutionView)

Description copied from interface: Move

Do not override this default implementation.

Specified by:

execute in interface Move<Solution_>

Specified by:

execute in interface Move<Solution_>

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 final Move<Solution_> rebase(Rebaser rebaser)

Description copied from interface: Move

Do not override this default implementation.

Specified by:

rebase in interface Move<Solution_>

Specified by:

rebase in interface Move<Solution_>

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

describe

public final String describe()

Description copied from interface: Move

Do not override this default implementation.

Specified by:

describe in interface Move<Solution_>

Specified by:

describe in interface Move<Solution_>

Returns:

Non-empty String that describes the move type.