Class ElementDestinationSelector<Solution_>
java.lang.Object
org.optaplanner.core.impl.heuristic.selector.AbstractSelector<Solution_>
org.optaplanner.core.impl.heuristic.selector.move.generic.list.ElementDestinationSelector<Solution_>
- Type Parameters:
Solution_
- the solution type, the class with thePlanningSolution
annotation
- All Implemented Interfaces:
Iterable<ElementRef>
,EventListener
,IterableSelector<Solution_,
,ElementRef> Selector<Solution_>
,PhaseLifecycleListener<Solution_>
,SolverLifecycleListener<Solution_>
public class ElementDestinationSelector<Solution_>
extends AbstractSelector<Solution_>
implements IterableSelector<Solution_,ElementRef>
Selects destinations for list variable change moves. The destination specifies a future position in a list variable,
expressed as an
ElementRef
, where a moved element or subList can be inserted.
Destination completeness is achieved by using both entity and value child selectors. When an entity A is selected, the destination becomes A[0]. When a value x is selected, its current position A[i] is determined using inverse and index supplies and the destination becomes A[i + 1].
Fairness in random selection is achieved by first deciding between entity and value selector with a probability that is proportional to the entity/value ratio. The child entity and value selectors are assumed to be fair.
-
Field Summary
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
Constructor Summary
ConstructorDescriptionElementDestinationSelector
(ListVariableDescriptor<Solution_> listVariableDescriptor, EntitySelector<Solution_> entitySelector, EntityIndependentValueSelector<Solution_> valueSelector, boolean randomSelection) -
Method Summary
Modifier and TypeMethodDescriptionlong
getSize()
A random JITSelector
withSelector.isNeverEnding()
true should return a size as if it would be able to return each distinct element only once, because the size can be used inSelectionProbabilityWeightFactory
.boolean
If false, thenSelector.isNeverEnding()
is true.boolean
Is true ifSelector.isCountable()
is false or if this selector is in random order (for most cases).iterator()
void
solvingEnded
(SolverScope<Solution_> solverScope) void
solvingStarted
(SolverScope<Solution_> solverScope) toString()
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
getCacheType, phaseEnded, phaseStarted, stepEnded, stepStarted
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.IterableSelector
spliterator
Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener
phaseEnded, phaseStarted, stepEnded, stepStarted
Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.Selector
getCacheType
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingError
-
Constructor Details
-
ElementDestinationSelector
public ElementDestinationSelector(ListVariableDescriptor<Solution_> listVariableDescriptor, EntitySelector<Solution_> entitySelector, EntityIndependentValueSelector<Solution_> valueSelector, boolean randomSelection)
-
-
Method Details
-
solvingStarted
- Specified by:
solvingStarted
in interfaceSolverLifecycleListener<Solution_>
- Overrides:
solvingStarted
in classAbstractSelector<Solution_>
-
solvingEnded
- Specified by:
solvingEnded
in interfaceSolverLifecycleListener<Solution_>
- Overrides:
solvingEnded
in classAbstractSelector<Solution_>
-
getSize
public long getSize()Description copied from interface:IterableSelector
A random JITSelector
withSelector.isNeverEnding()
true should return a size as if it would be able to return each distinct element only once, because the size can be used inSelectionProbabilityWeightFactory
.- Specified by:
getSize
in interfaceIterableSelector<Solution_,
ElementRef> - Returns:
- the approximate number of elements generated by this
Selector
, always>= 0
-
iterator
-
isCountable
public boolean isCountable()Description copied from interface:Selector
If false, thenSelector.isNeverEnding()
is true.- Specified by:
isCountable
in interfaceSelector<Solution_>
- Returns:
- true if all the
ValueRange
s are countable (for example a double value range between 1.2 and 1.4 is not countable)
-
isNeverEnding
public boolean isNeverEnding()Description copied from interface:Selector
Is true ifSelector.isCountable()
is false or if this selector is in random order (for most cases). Is never true when this selector is in shuffled order (which is less scalable but more exact).- Specified by:
isNeverEnding
in interfaceSelector<Solution_>
- Returns:
- true if the
Iterator.hasNext()
of theIterator
created byIterable.iterator()
never returns false (except when it's empty).
-
toString
-