Class DefaultPillarSelector
- java.lang.Object
-
- org.optaplanner.core.impl.heuristic.selector.AbstractSelector
-
- org.optaplanner.core.impl.heuristic.selector.entity.pillar.DefaultPillarSelector
-
- All Implemented Interfaces:
Iterable<List<Object>>
,EventListener
,ListIterable<List<Object>>
,SelectionCacheLifecycleListener
,PillarSelector
,IterableSelector<List<Object>>
,ListIterableSelector<List<Object>>
,Selector
,PhaseLifecycleListener
,SolverLifecycleListener
public class DefaultPillarSelector extends AbstractSelector implements PillarSelector, SelectionCacheLifecycleListener
- See Also:
PillarSelector
-
-
Field Summary
Fields Modifier and Type Field Description protected static SelectionCacheType
CACHE_TYPE
protected List<List<Object>>
cachedBasePillarList
protected EntitySelector
entitySelector
protected boolean
randomSelection
protected SubPillarConfigPolicy
subpillarConfigPolicy
protected List<GenuineVariableDescriptor>
variableDescriptors
-
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
-
Constructor Summary
Constructors Constructor Description DefaultPillarSelector(EntitySelector entitySelector, List<GenuineVariableDescriptor> variableDescriptors, boolean randomSelection, SubPillarConfigPolicy subpillarConfigPolicy)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
constructCache(DefaultSolverScope solverScope)
void
disposeCache(DefaultSolverScope solverScope)
SelectionCacheType
getCacheType()
Unless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME
, even if a selector child caches.EntityDescriptor
getEntityDescriptor()
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
.boolean
isCountable()
If false, thenSelector.isNeverEnding()
is true.boolean
isNeverEnding()
Is true ifSelector.isCountable()
is false or if this selector is in random order (for most cases).Iterator<List<Object>>
iterator()
ListIterator<List<Object>>
listIterator()
ListIterator<List<Object>>
listIterator(int index)
String
toString()
-
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
phaseEnded, phaseStarted, solvingEnded, solvingStarted, stepEnded, stepStarted
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener
phaseEnded, phaseStarted, stepEnded, stepStarted
-
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
-
-
-
-
Field Detail
-
CACHE_TYPE
protected static final SelectionCacheType CACHE_TYPE
-
entitySelector
protected final EntitySelector entitySelector
-
variableDescriptors
protected final List<GenuineVariableDescriptor> variableDescriptors
-
randomSelection
protected final boolean randomSelection
-
subpillarConfigPolicy
protected final SubPillarConfigPolicy subpillarConfigPolicy
-
-
Constructor Detail
-
DefaultPillarSelector
public DefaultPillarSelector(EntitySelector entitySelector, List<GenuineVariableDescriptor> variableDescriptors, boolean randomSelection, SubPillarConfigPolicy subpillarConfigPolicy)
-
-
Method Detail
-
getEntityDescriptor
public EntityDescriptor getEntityDescriptor()
- Specified by:
getEntityDescriptor
in interfacePillarSelector
- Returns:
- never null
-
getCacheType
public SelectionCacheType 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
- Overrides:
getCacheType
in classAbstractSelector
- Returns:
- never null
-
constructCache
public void constructCache(DefaultSolverScope solverScope)
- Specified by:
constructCache
in interfaceSelectionCacheLifecycleListener
-
disposeCache
public void disposeCache(DefaultSolverScope solverScope)
- Specified by:
disposeCache
in interfaceSelectionCacheLifecycleListener
-
isCountable
public boolean isCountable()
Description copied from interface:Selector
If false, thenSelector.isNeverEnding()
is true.- Specified by:
isCountable
in interfaceSelector
- 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
- 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<List<Object>>
- Returns:
- the approximate number of elements generated by this
Selector
, always>= 0
-
listIterator
public ListIterator<List<Object>> listIterator()
- Specified by:
listIterator
in interfaceListIterable<List<Object>>
- Returns:
- never null, see
List.listIterator()
. - See Also:
List.listIterator()
-
listIterator
public ListIterator<List<Object>> listIterator(int index)
- Specified by:
listIterator
in interfaceListIterable<List<Object>>
- Parameters:
index
- lower than the size of thisListIterable
, seeList.listIterator(int)
.- Returns:
- never null, see
List.listIterator(int)
. - See Also:
List.listIterator()
-
-