org.optaplanner.core.impl.heuristic.selector.move.generic.chained

Class ChainedChangeMove<Solution_>

java.lang.Object

org.optaplanner.core.impl.heuristic.move.AbstractMove<Solution_>

org.optaplanner.core.impl.heuristic.selector.move.generic.ChangeMove<Solution_>

org.optaplanner.core.impl.heuristic.selector.move.generic.chained.ChainedChangeMove<Solution_>

Type Parameters:

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

All Implemented Interfaces:

Move<Solution_>

public class ChainedChangeMove<Solution_>
extends ChangeMove<Solution_>

Field Summary

Fields

Modifier and Type	Field and Description
protected SingletonInverseVariableSupply	inverseVariableSupply

Fields inherited from class org.optaplanner.core.impl.heuristic.selector.move.generic.ChangeMove

entity, toPlanningValue, variableDescriptor

Constructor Summary

Constructors

Constructor and Description
ChainedChangeMove(Object entity, GenuineVariableDescriptor<Solution_> variableDescriptor, SingletonInverseVariableSupply inverseVariableSupply, Object toPlanningValue)

Method Summary

Modifier and Type	Method and Description
ChainedChangeMove<Solution_>	createUndoMove(ScoreDirector<Solution_> scoreDirector) 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.
protected void	doMoveOnGenuineVariables(ScoreDirector<Solution_> scoreDirector) Like AbstractMove.doMove(ScoreDirector) but without the ScoreDirector.triggerVariableListeners() call (because AbstractMove.doMove(ScoreDirector) already does that).
boolean	isMoveDoable(ScoreDirector<Solution_> scoreDirector) Called before a move is evaluated to decide whether the move can be done and evaluated.

Methods inherited from class org.optaplanner.core.impl.heuristic.selector.move.generic.ChangeMove

equals, getEntity, getPlanningEntities, getPlanningValues, getSimpleMoveTypeDescription, getToPlanningValue, getVariableName, hashCode, toString

Methods inherited from class org.optaplanner.core.impl.heuristic.move.AbstractMove

doMove

Methods inherited from class java.lang.Object

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

Field Detail

inverseVariableSupply

protected final SingletonInverseVariableSupply inverseVariableSupply

Constructor Detail

ChainedChangeMove

public ChainedChangeMove(Object entity,
                         GenuineVariableDescriptor<Solution_> variableDescriptor,
                         SingletonInverseVariableSupply inverseVariableSupply,
                         Object toPlanningValue)

Method Detail

isMoveDoable

public boolean isMoveDoable(ScoreDirector<Solution_> scoreDirector)

Description copied from interface: Move

Called before a move is evaluated to decide whether the move can be done and evaluated. A Move is not doable if:

• Either doing it would change nothing in the PlanningSolution.
• Either it's simply not possible to do (for example due to built-in hard constraints).

It is recommended to keep this method implementation simple: do not use it in an attempt to satisfy normal hard and soft constraints.

Although you could also filter out non-doable moves in for example the MoveSelector or MoveListFactory, this is not needed as the Solver will do it for you.

Specified by:

isMoveDoable in interface Move<Solution_>

Overrides:

isMoveDoable in class ChangeMove<Solution_>

Parameters:

scoreDirector - the ScoreDirector not yet modified by the move.

Returns:

true if the move achieves a change in the solution and the move is possible to do on the solution.

createUndoMove

public ChainedChangeMove<Solution_> createUndoMove(ScoreDirector<Solution_> scoreDirector)

Description copied from class: AbstractMove

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.

Overrides:

createUndoMove in class ChangeMove<Solution_>

Parameters:

scoreDirector - the ScoreDirector not yet modified by the move.

Returns:

an undoMove which does the exact opposite of this move.

doMoveOnGenuineVariables

protected void doMoveOnGenuineVariables(ScoreDirector<Solution_> scoreDirector)

Description copied from class: AbstractMove

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

Overrides:

doMoveOnGenuineVariables in class ChangeMove<Solution_>

Parameters:

scoreDirector - never null