Class FromSolutionEntitySelector<Solution_>
java.lang.Object
org.optaplanner.core.impl.heuristic.selector.AbstractSelector<Solution_>
org.optaplanner.core.impl.heuristic.selector.AbstractDemandEnabledSelector<Solution_>
org.optaplanner.core.impl.heuristic.selector.entity.FromSolutionEntitySelector<Solution_>
- All Implemented Interfaces:
Iterable<Object>
,EventListener
,ListIterable<Object>
,EntitySelector<Solution_>
,IterableSelector<Solution_,
,Object> ListIterableSelector<Solution_,
,Object> Selector<Solution_>
,PhaseLifecycleListener<Solution_>
,SolverLifecycleListener<Solution_>
public final class FromSolutionEntitySelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements EntitySelector<Solution_>
This is the common
EntitySelector
implementation.-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
protected Long
protected final EntityDescriptor<Solution_>
protected final SelectionCacheType
protected final boolean
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
Constructor Summary
ConstructorDescriptionFromSolutionEntitySelector
(EntityDescriptor<Solution_> entityDescriptor, SelectionCacheType minimumCacheType, boolean randomSelection) -
Method Summary
Modifier and TypeMethodDescriptionIfSelector.isNeverEnding()
is true, thenIterable.iterator()
will never end.boolean
Unless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME
, even if a selector child caches.long
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
.int
hashCode()
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()
listIterator
(int index) void
phaseEnded
(AbstractPhaseScope<Solution_> phaseScope) void
phaseStarted
(AbstractPhaseScope<Solution_> phaseScope) void
stepStarted
(AbstractStepScope<Solution_> stepScope) toString()
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
solvingEnded, solvingStarted, stepEnded
Methods inherited from class java.lang.Object
clone, finalize, getClass, 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
stepEnded
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingError, solvingStarted
-
Field Details
-
entityDescriptor
-
minimumCacheType
-
randomSelection
protected final boolean randomSelection -
cachedEntityList
-
cachedEntityListRevision
-
cachedEntityListIsDirty
protected boolean cachedEntityListIsDirty
-
-
Constructor Details
-
FromSolutionEntitySelector
public FromSolutionEntitySelector(EntityDescriptor<Solution_> entityDescriptor, SelectionCacheType minimumCacheType, boolean randomSelection)
-
-
Method Details
-
getEntityDescriptor
- Specified by:
getEntityDescriptor
in interfaceEntitySelector<Solution_>
- Returns:
- never null
-
getCacheType
Description copied from interface:Selector
Unless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME
, even if a selector child caches.- Specified by:
getCacheType
in interfaceSelector<Solution_>
- Overrides:
getCacheType
in classAbstractSelector<Solution_>
- Returns:
- never null, at least
SelectionCacheType.STEP
-
phaseStarted
- Specified by:
phaseStarted
in interfacePhaseLifecycleListener<Solution_>
- Overrides:
phaseStarted
in classAbstractSelector<Solution_>
-
stepStarted
- Specified by:
stepStarted
in interfacePhaseLifecycleListener<Solution_>
- Overrides:
stepStarted
in classAbstractSelector<Solution_>
-
phaseEnded
- Specified by:
phaseEnded
in interfacePhaseLifecycleListener<Solution_>
- Overrides:
phaseEnded
in classAbstractSelector<Solution_>
-
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).
-
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_,
Object> - Returns:
- the approximate number of elements generated by this
Selector
, always>= 0
-
iterator
-
listIterator
- Specified by:
listIterator
in interfaceListIterable<Solution_>
- Returns:
- never null, see
List.listIterator()
. - See Also:
-
listIterator
- Specified by:
listIterator
in interfaceListIterable<Solution_>
- Parameters:
index
- lower than the size of thisListIterable
, seeList.listIterator(int)
.- Returns:
- never null, see
List.listIterator(int)
. - See Also:
-
endingIterator
Description copied from interface:EntitySelector
IfSelector.isNeverEnding()
is true, thenIterable.iterator()
will never end. This returns an endingIterator
, that tries to matchIterable.iterator()
as much as possible, but returns each distinct element only once and returns every element that might possibly be selected and therefore it might not respect the configuration of thisEntitySelector
entirely.- Specified by:
endingIterator
in interfaceEntitySelector<Solution_>
- Returns:
- never null
- See Also:
-
equals
- Specified by:
equals
in classAbstractDemandEnabledSelector<Solution_>
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractDemandEnabledSelector<Solution_>
-
toString
-