|
OptaPlanner core 6.2.0.Beta2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.optaplanner.core.impl.heuristic.move.AbstractMove
org.optaplanner.core.impl.heuristic.move.CompositeMove
public class CompositeMove
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.
Move
Field Summary | |
---|---|
protected List<Move> |
moveList
|
Constructor Summary | |
---|---|
CompositeMove(List<Move> moveList)
|
Method Summary | |
---|---|
static Move |
buildMove(List<Move> moveList)
|
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 and updates the Solution and its ScoreDirector accordingly. |
boolean |
equals(Object o)
|
List<Move> |
getMoveList()
|
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 |
---|
protected final List<Move> moveList
Constructor Detail |
---|
public CompositeMove(List<Move> moveList)
moveList
- never nullMethod Detail |
---|
public static Move buildMove(List<Move> moveList)
public List<Move> getMoveList()
public boolean isMoveDoable(ScoreDirector scoreDirector)
Move
Solution
.MoveSelector
or MoveListFactory
, this is not needed as the Solver
will do it for you.
scoreDirector
- the ScoreDirector
not yet modified by the move.
public CompositeMove createUndoMove(ScoreDirector scoreDirector)
Move
scoreDirector
- the ScoreDirector
not yet modified by the move.
public void doMove(ScoreDirector scoreDirector)
Move
Solution
and its ScoreDirector
accordingly.
When the Solution
is modified, the ScoreDirector
should be correctly notified,
otherwise later calculated Score
s can be corrupted.
scoreDirector
- never null, the ScoreDirector
that needs to get notified of the changes.public String getSimpleMoveTypeDescription()
Move
String
returned by this method.
getSimpleMoveTypeDescription
in interface Move
getSimpleMoveTypeDescription
in class AbstractMove
public Collection<? extends Object> getPlanningEntities()
Move
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
.
public Collection<? extends Object> getPlanningValues()
Move
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
.
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
|
OptaPlanner core 6.2.0.Beta2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |