org.optaplanner.core.impl.heuristic.move

Class NoChangeMove

java.lang.Object

org.optaplanner.core.impl.heuristic.move.AbstractMove

org.optaplanner.core.impl.heuristic.move.NoChangeMove

All Implemented Interfaces:

Move

public class NoChangeMove
extends AbstractMove

Makes no changes.

Constructor Summary

Constructors

Constructor and Description
NoChangeMove()

Method Summary

Methods

Modifier and Type	Method and Description
Move	createUndoMove(ScoreDirector 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.
void	doMove(ScoreDirector scoreDirector) Does the Move and updates the Solution and its ScoreDirector accordingly.
Collection<? extends Object>	getPlanningEntities() Returns all planning entities that are being changed by this move.
Collection<? extends Object>	getPlanningValues() Returns all planning values that entities are being assigned to by this move.
boolean	isMoveDoable(ScoreDirector scoreDirector) Called before a move is evaluated to decide whether the move can be done and evaluated.
String	toString()

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

getSimpleMoveTypeDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

NoChangeMove

public NoChangeMove()

Method Detail

isMoveDoable

public boolean isMoveDoable(ScoreDirector 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 Solution.
• Either it's simply not possible to do (for example due to build-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.

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 Move createUndoMove(ScoreDirector scoreDirector)

Description copied from interface: Move

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.

doMove

public void doMove(ScoreDirector scoreDirector)

Description copied from interface: Move

Does the Move and updates the Solution and its ScoreDirector accordingly. When the Solution is modified, the ScoreDirector should be correctly notified, otherwise later calculated Scores can be corrupted.

Parameters:

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

getPlanningEntities

public Collection<? extends Object> getPlanningEntities()

Description copied from interface: Move

Returns all planning entities that are being changed by this move. Required for AcceptorType.ENTITY_TABU.

Duplicates entries in the returned Collection are best avoided. The returned Collection is recommended to be in a stable order. For example: use List or LinkedHashSet, but not HashSet.

Returns:

never null

getPlanningValues

public Collection<? extends Object> getPlanningValues()

Description copied from interface: Move

Returns all planning values that entities are being assigned to by this move. Required for AcceptorType.VALUE_TABU.

Duplicates entries in the returned Collection are best avoided. The returned Collection is recommended to be in a stable order. For example: use List or LinkedHashSet, but not HashSet.

Returns:

never null

toString

public String toString()

Overrides:

toString in class Object