org.optaplanner.core.impl.heuristic.move

Class CompositeMove

java.lang.Object

org.optaplanner.core.impl.heuristic.move.CompositeMove

All Implemented Interfaces:

Move

public class CompositeMove
extends Object
implements Move

A CompositeMove is composed out of multiple other moves.

Warning: each of moves in the moveList must not rely on the effect of a previous move in the moveList to create its undoMove correctly.

See Also:

Move

Field Summary

Fields

Modifier and Type	Field and Description
protected Move[]	moves

Constructor Summary

Constructors

Constructor and Description
CompositeMove(Move... moves)

Method Summary

Methods

Modifier and Type	Method and Description
static Move	buildMove(List<Move> moveList)
static Move	buildMove(Move... moves)
CompositeMove	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 (which indirectly affects the ScoreDirector.getWorkingSolution()).
boolean	equals(Object o)
Move[]	getMoves()
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.
String	getSimpleMoveTypeDescription() Describes the move type for statistical purposes.
int	hashCode()
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 java.lang.Object

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

Field Detail

moves

protected final Move[] moves

Constructor Detail

CompositeMove

public CompositeMove(Move... moves)

Parameters:

moves - never null, never empty. Do not modify this argument afterwards or this CompositeMove corrupts.

Method Detail

buildMove

public static Move buildMove(Move... moves)

Parameters:

moves - never null, sometimes empty. Do not modify this argument afterwards or the CompositeMove corrupts.

Returns:

never null

buildMove

public static Move buildMove(List<Move> moveList)

Parameters:

moveList - never null, sometimes empty

Returns:

never null

getMoves

public Move[] getMoves()

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.

Specified by:

isMoveDoable in interface Move

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 CompositeMove 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.

Specified by:

createUndoMove in interface Move

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 (which indirectly affects the ScoreDirector.getWorkingSolution()). When the workingSolution is modified, the ScoreDirector must be correctly notified (through ScoreDirector.beforeVariableChanged(Object, String), ScoreDirector.afterProblemFactChanged(Object), etc), otherwise later calculated Scores will be corrupted.

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

Specified by:

doMove in interface Move

Parameters:

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

getSimpleMoveTypeDescription

public String getSimpleMoveTypeDescription()

Description copied from interface: Move

Describes the move type for statistical purposes. For example "ChangeMove(Process.computer)".

The format is not formalized. Never parse the String returned by this method.

Specified by:

getSimpleMoveTypeDescription in interface Move

Returns:

never null

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.

Specified by:

getPlanningEntities in interface Move

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.

Specified by:

getPlanningValues in interface Move

Returns:

never null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object