Solution_
- the solution type, the class with the PlanningSolution
annotationpublic interface Move<Solution_>
PlanningVariable
s of 1 or more PlanningEntity
s
in the working PlanningSolution
.
Usually the move holds a direct reference to each PlanningEntity
of the PlanningSolution
which 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()
for MoveTabuAcceptor
.
An implementation must extend AbstractMove
to ensure backwards compatibility in future versions.
AbstractMove
Modifier and Type | Method and Description |
---|---|
Move<Solution_> |
doMove(ScoreDirector<Solution_> scoreDirector)
Does the move (which indirectly affects the
ScoreDirector.getWorkingSolution() ). |
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.
|
boolean |
isMoveDoable(ScoreDirector<Solution_> scoreDirector)
Called before a move is evaluated to decide whether the move can be done and evaluated.
|
boolean isMoveDoable(ScoreDirector<Solution_> scoreDirector)
PlanningSolution
.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.
scoreDirector
- the ScoreDirector
not yet modified by the move.Move<Solution_> doMove(ScoreDirector<Solution_> scoreDirector)
ScoreDirector.getWorkingSolution()
).
When the working solution
is modified, the ScoreDirector
must be correctly notified
(through ScoreDirector.beforeVariableChanged(Object, String)
and
ScoreDirector.afterVariableChanged(Object, String)
),
otherwise later calculated Score
s will be corrupted.
This method must end with calling ScoreDirector.triggerVariableListeners()
to ensure all shadow variables are updated.
This method must return an undo move, so the move can be evaluated and then be undone without resulting into a permanent change in the solution.
scoreDirector
- never null, the ScoreDirector
that needs to get notified of the changesString getSimpleMoveTypeDescription()
The format is not formalized. Never parse the String
returned by this method.
Collection<? extends Object> getPlanningEntities()
AcceptorType.ENTITY_TABU
.
Duplicate 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
.
Duplicate 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
.
Copyright © 2006–2017 JBoss by Red Hat. All rights reserved.