Class ListChangeMove<Solution_>
- Type Parameters:
Solution_
- the solution type, the class with thePlanningSolution
annotation
- All Implemented Interfaces:
Move<Solution_>
list variable
. The moved element is identified
by an entity instance and a position in that entity's list variable. The element is inserted at the given index
in the given destination entity's list variable.
An undo move is simply created by flipping the source and destination entity+index.
-
Constructor Summary
ConstructorsConstructorDescriptionListChangeMove
(ListVariableDescriptor<Solution_> variableDescriptor, Object sourceEntity, int sourceIndex, Object destinationEntity, int destinationIndex) The move removes a planning value element fromsourceEntity.listVariable[sourceIndex]
and inserts the planning value atdestinationEntity.listVariable[destinationIndex]
. -
Method Summary
Modifier and TypeMethodDescriptioncreateUndoMove
(ScoreDirector<Solution_> 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.protected void
doMoveOnGenuineVariables
(ScoreDirector<Solution_> scoreDirector) LikeAbstractMove.doMoveOnly(ScoreDirector)
but without theScoreDirector.triggerVariableListeners()
call (becauseAbstractMove.doMoveOnly(ScoreDirector)
already does that).boolean
int
Returns all planning entities that are being changed by this move.Returns all planning values that entities are being assigned to by this move.Describes the move type for statistical purposes.int
int
hashCode()
boolean
isMoveDoable
(ScoreDirector<Solution_> scoreDirector) Called before a move is evaluated to decide whether the move can be done and evaluated.rebase
(ScoreDirector<Solution_> destinationScoreDirector) Rebases a move from an originScoreDirector
to another destinationScoreDirector
which is usually on anotherThread
or JVM.toString()
Methods inherited from class org.optaplanner.core.impl.heuristic.move.AbstractMove
doMove, doMoveOnly, rebaseArray, rebaseList
-
Constructor Details
-
ListChangeMove
public ListChangeMove(ListVariableDescriptor<Solution_> variableDescriptor, Object sourceEntity, int sourceIndex, Object destinationEntity, int destinationIndex) The move removes a planning value element fromsourceEntity.listVariable[sourceIndex]
and inserts the planning value atdestinationEntity.listVariable[destinationIndex]
.ListChangeMove anatomy
/ destinationEntity | / destinationIndex | | A {Ann[0]}->{Bob[2]} | | | planning value / | \ sourceIndex \ sourceEntity
Example 1 - source and destination entities are different
GIVEN Ann.tasks = [A, B, C] Bob.tasks = [X, Y] WHEN ListChangeMove: A {Ann[0]->Bob[2]} THEN Ann.tasks = [B, C] Bob.tasks = [X, Y, A]
Example 2 - source and destination is the same entity
GIVEN Ann.tasks = [A, B, C] WHEN ListChangeMove: A {Ann[0]->Ann[2]} THEN Ann.tasks = [B, C, A]
- Parameters:
variableDescriptor
- descriptor of a list variable, for exampleEmployee.taskList
sourceEntity
- planning entity instance from which a planning value will be removed, for example "Ann"sourceIndex
- index in sourceEntity's list variable from which a planning value will be removeddestinationEntity
- planning entity instance to which a planning value will be moved, for example "Bob"destinationIndex
- index in destinationEntity's list variable where the moved planning value will be inserted
-
-
Method Details
-
getSourceEntity
-
getSourceIndex
public int getSourceIndex() -
getDestinationEntity
-
getDestinationIndex
public int getDestinationIndex() -
getMovedValue
-
isMoveDoable
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
PlanningSolution
. - Either it's simply not possible to do (for example due to built-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
orMoveListFactory
, this is not needed as theSolver
will do it for you.- Parameters:
scoreDirector
- theScoreDirector
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.
- Either doing it would change nothing in the
-
createUndoMove
Description copied from class:AbstractMove
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 classAbstractMove<Solution_>
- Parameters:
scoreDirector
- theScoreDirector
not yet modified by the move.- Returns:
- an undoMove which does the exact opposite of this move.
-
doMoveOnGenuineVariables
Description copied from class:AbstractMove
LikeAbstractMove.doMoveOnly(ScoreDirector)
but without theScoreDirector.triggerVariableListeners()
call (becauseAbstractMove.doMoveOnly(ScoreDirector)
already does that).- Specified by:
doMoveOnGenuineVariables
in classAbstractMove<Solution_>
- Parameters:
scoreDirector
- never null
-
rebase
Description copied from interface:Move
Rebases a move from an originScoreDirector
to another destinationScoreDirector
which is usually on anotherThread
or JVM. The new move returned by this method translates the entities and problem facts to the destinationPlanningSolution
of the destinationScoreDirector
, That destinationPlanningSolution
is a deep planning clone (or an even deeper clone) of the originPlanningSolution
that this move has been generated from.That new move does the exact same change as this move, resulting in the same
PlanningSolution
state, presuming that destinationPlanningSolution
was in the same state as the originalPlanningSolution
to begin with.Generally speaking, an implementation of this method iterates through every entity and fact instance in this move, translates each one to the destination
ScoreDirector
withScoreDirector.lookUpWorkingObject(Object)
and creates a new move instance of the same move type, using those translated instances.The destination
PlanningSolution
can be in a different state than the originalPlanningSolution
. So, rebasing can only depend on the identity ofplanning entities
and planning facts, which is usually declared by aPlanningId
on those classes. It must not depend on the state of theplanning variables
. One thread might rebase a move before, amid or after another thread does that same move instance.This method is thread-safe.
- Parameters:
destinationScoreDirector
- never null, theScoreDirector.getWorkingSolution()
that the new move should change the planning entity instances of.- Returns:
- never null, a new move that does the same change as this move on another solution instance
-
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.- Returns:
- never null
-
getPlanningEntities
Description copied from interface:Move
Returns all planning entities that are being changed by this move. Required forAcceptorType.ENTITY_TABU
.This method is only called after
Move.doMove(ScoreDirector)
(which might affect the return values).Duplicate entries in the returned
Collection
are best avoided. The returnedCollection
is recommended to be in a stable order. For example: useList
orLinkedHashSet
, but notHashSet
.- Returns:
- never null
-
getPlanningValues
Description copied from interface:Move
Returns all planning values that entities are being assigned to by this move. Required forAcceptorType.VALUE_TABU
.This method is only called after
Move.doMove(ScoreDirector)
(which might affect the return values).Duplicate entries in the returned
Collection
are best avoided. The returnedCollection
is recommended to be in a stable order. For example: useList
orLinkedHashSet
, but notHashSet
.- Returns:
- never null
-
equals
-
hashCode
public int hashCode() -
toString
-