Class SelectedCountLimitEntitySelector<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.decorator.SelectedCountLimitEntitySelector<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 SelectedCountLimitEntitySelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements EntitySelector<Solution_>
-
Field Summary
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
Constructor Summary
ConstructorsConstructorDescriptionSelectedCountLimitEntitySelector
(EntitySelector<Solution_> childEntitySelector, boolean randomSelection, long selectedCountLimit) -
Method Summary
Modifier and TypeMethodDescriptionIfSelector.isNeverEnding()
is true, thenIterable.iterator()
will never end.boolean
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) toString()
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
getCacheType, phaseEnded, phaseStarted, solvingEnded, solvingStarted, stepEnded, stepStarted
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
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
solvingEnded, solvingError, solvingStarted
-
Constructor Details
-
SelectedCountLimitEntitySelector
public SelectedCountLimitEntitySelector(EntitySelector<Solution_> childEntitySelector, boolean randomSelection, long selectedCountLimit)
-
-
Method Details
-
getEntityDescriptor
- Specified by:
getEntityDescriptor
in interfaceEntitySelector<Solution_>
- Returns:
- never null
-
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
-