Class ListAssignMove<Solution_>
- java.lang.Object
-
- org.optaplanner.core.impl.heuristic.move.AbstractMove<Solution_>
-
- org.optaplanner.core.impl.heuristic.selector.move.generic.list.ListAssignMove<Solution_>
-
- All Implemented Interfaces:
Move<Solution_>
public class ListAssignMove<Solution_> extends AbstractMove<Solution_>
-
-
Constructor Summary
Constructors Constructor Description ListAssignMove(ListVariableDescriptor<Solution_> variableDescriptor, Object planningValue, Object destinationEntity, int destinationIndex)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListUnassignMove<Solution_>createUndoMove(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 voiddoMoveOnGenuineVariables(ScoreDirector<Solution_> scoreDirector)LikeAbstractMove.doMoveOnly(ScoreDirector)but without theScoreDirector.triggerVariableListeners()call (becauseAbstractMove.doMoveOnly(ScoreDirector)already does that).booleanequals(Object o)ObjectgetDestinationEntity()intgetDestinationIndex()ObjectgetMovedValue()StringgetSimpleMoveTypeDescription()Describes the move type for statistical purposes.inthashCode()booleanisMoveDoable(ScoreDirector<Solution_> scoreDirector)Called before a move is evaluated to decide whether the move can be done and evaluated.ListAssignMove<Solution_>rebase(ScoreDirector<Solution_> destinationScoreDirector)Rebases a move from an originScoreDirectorto another destinationScoreDirectorwhich is usually on anotherThreador JVM.StringtoString()-
Methods inherited from class org.optaplanner.core.impl.heuristic.move.AbstractMove
doMove, doMoveOnly, rebaseArray, rebaseList
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.optaplanner.core.impl.heuristic.move.Move
getPlanningEntities, getPlanningValues
-
-
-
-
Constructor Detail
-
ListAssignMove
public ListAssignMove(ListVariableDescriptor<Solution_> variableDescriptor, Object planningValue, Object destinationEntity, int destinationIndex)
-
-
Method Detail
-
getDestinationEntity
public Object getDestinationEntity()
-
getDestinationIndex
public int getDestinationIndex()
-
getMovedValue
public Object getMovedValue()
-
isMoveDoable
public boolean isMoveDoable(ScoreDirector<Solution_> scoreDirector)
Description copied from interface:MoveCalled 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
MoveSelectororMoveListFactory, this is not needed as theSolverwill do it for you.- Parameters:
scoreDirector- theScoreDirectornot 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
public ListUnassignMove<Solution_> createUndoMove(ScoreDirector<Solution_> scoreDirector)
Description copied from class:AbstractMoveCalled 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:
createUndoMovein classAbstractMove<Solution_>- Parameters:
scoreDirector- theScoreDirectornot yet modified by the move.- Returns:
- an undoMove which does the exact opposite of this move.
-
doMoveOnGenuineVariables
protected void doMoveOnGenuineVariables(ScoreDirector<Solution_> scoreDirector)
Description copied from class:AbstractMoveLikeAbstractMove.doMoveOnly(ScoreDirector)but without theScoreDirector.triggerVariableListeners()call (becauseAbstractMove.doMoveOnly(ScoreDirector)already does that).- Specified by:
doMoveOnGenuineVariablesin classAbstractMove<Solution_>- Parameters:
scoreDirector- never null
-
rebase
public ListAssignMove<Solution_> rebase(ScoreDirector<Solution_> destinationScoreDirector)
Description copied from interface:MoveRebases a move from an originScoreDirectorto another destinationScoreDirectorwhich is usually on anotherThreador JVM. The new move returned by this method translates the entities and problem facts to the destinationPlanningSolutionof the destinationScoreDirector, That destinationPlanningSolutionis a deep planning clone (or an even deeper clone) of the originPlanningSolutionthat this move has been generated from.That new move does the exact same change as this move, resulting in the same
PlanningSolutionstate, presuming that destinationPlanningSolutionwas in the same state as the originalPlanningSolutionto 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
ScoreDirectorwithScoreDirector.lookUpWorkingObject(Object)and creates a new move instance of the same move type, using those translated instances.The destination
PlanningSolutioncan be in a different state than the originalPlanningSolution. So, rebasing can only depend on the identity ofplanning entitiesand planning facts, which is usually declared by aPlanningIdon 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
public String getSimpleMoveTypeDescription()
Description copied from interface:MoveDescribes the move type for statistical purposes. For example "ChangeMove(Process.computer)".The format is not formalized. Never parse the
Stringreturned by this method.- Returns:
- never null
-
-