|
OptaPlanner core 6.1.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Move
A Move represents a change of 1 or more planning variables of 1 or more planning entities in the Solution
.
Solution
that it will change when doMove(ScoreDirector)
is called.
On that change it should also notify the ScoreDirector
accordingly.
A Move should implement Object.equals(Object)
and Object.hashCode()
.
Method Summary | |
---|---|
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. |
Method Detail |
---|
boolean isMoveDoable(ScoreDirector scoreDirector)
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.
Move createUndoMove(ScoreDirector scoreDirector)
scoreDirector
- the ScoreDirector
not yet modified by the move.
void doMove(ScoreDirector scoreDirector)
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.Collection<? extends Object> getPlanningEntities()
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
.
Collection<? extends Object> getPlanningValues()
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
.
|
OptaPlanner core 6.1.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |