|
OptaPlanner distribution 6.1.0.CR2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.optaplanner.core.impl.heuristic.selector.AbstractSelector
org.optaplanner.core.impl.heuristic.selector.entity.AbstractEntitySelector
org.optaplanner.core.impl.heuristic.selector.entity.decorator.ProbabilityEntitySelector
public class ProbabilityEntitySelector
| Field Summary | |
|---|---|
protected NavigableMap<Double,Object> |
cachedEntityMap
|
protected SelectionCacheType |
cacheType
|
protected EntitySelector |
childEntitySelector
|
protected SelectionProbabilityWeightFactory |
probabilityWeightFactory
|
protected double |
probabilityWeightTotal
|
| Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector |
|---|
logger, phaseLifecycleSupport, workingRandom |
| Constructor Summary | |
|---|---|
ProbabilityEntitySelector(EntitySelector childEntitySelector,
SelectionCacheType cacheType,
SelectionProbabilityWeightFactory probabilityWeightFactory)
|
|
| Method Summary | |
|---|---|
void |
constructCache(DefaultSolverScope solverScope)
|
void |
disposeCache(DefaultSolverScope solverScope)
|
Iterator<Object> |
endingIterator()
If Selector.isNeverEnding() is true, then Iterable.iterator() will never end. |
SelectionCacheType |
getCacheType()
Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME,
even if a selector child caches. |
EntityDescriptor |
getEntityDescriptor()
|
long |
getSize()
A random JIT Selector with Selector.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 in SelectionProbabilityWeightFactory. |
boolean |
isCountable()
If false, then Selector.isNeverEnding() is true. |
boolean |
isNeverEnding()
Is true if Selector.isCountable() is false
or if this selector is in random order (for most cases). |
Iterator<Object> |
iterator()
|
ListIterator<Object> |
listIterator()
See List.listIterator() |
ListIterator<Object> |
listIterator(int index)
See List.listIterator() |
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 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 |
|---|
protected final EntitySelector childEntitySelector
protected final SelectionCacheType cacheType
protected final SelectionProbabilityWeightFactory probabilityWeightFactory
protected NavigableMap<Double,Object> cachedEntityMap
protected double probabilityWeightTotal
| Constructor Detail |
|---|
public ProbabilityEntitySelector(EntitySelector childEntitySelector,
SelectionCacheType cacheType,
SelectionProbabilityWeightFactory probabilityWeightFactory)
| Method Detail |
|---|
public SelectionCacheType getCacheType()
SelectorSelectionCacheType.JUST_IN_TIME,
even if a selector child caches.
getCacheType in interface SelectorgetCacheType in class AbstractSelectorpublic void constructCache(DefaultSolverScope solverScope)
constructCache in interface SelectionCacheLifecycleListenerpublic void disposeCache(DefaultSolverScope solverScope)
disposeCache in interface SelectionCacheLifecycleListenerpublic EntityDescriptor getEntityDescriptor()
getEntityDescriptor in interface EntitySelectorpublic boolean isCountable()
SelectorSelector.isNeverEnding() is true.
isCountable in interface SelectorValueRanges are countable
(for example a double value range between 1.2 and 1.4 is not countable)public boolean isNeverEnding()
SelectorSelector.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).
isNeverEnding in interface SelectorIterator.hasNext() of the Iterator created by Iterable.iterator()
never returns false (except when it's empty).public long getSize()
IterableSelectorSelector with Selector.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 in SelectionProbabilityWeightFactory.
getSize in interface IterableSelector<Object>Selector, always >= 0public Iterator<Object> iterator()
iterator in interface Iterable<Object>public ListIterator<Object> listIterator()
ListIterableList.listIterator()
listIterator in interface ListIterable<Object>List.listIterator().public ListIterator<Object> listIterator(int index)
ListIterableList.listIterator()
listIterator in interface ListIterable<Object>index - lower than the size of this ListIterable, see List.listIterator(int).
List.listIterator(int).public Iterator<Object> endingIterator()
EntitySelectorSelector.isNeverEnding() is true, then Iterable.iterator() will never end.
This returns an ending Iterator, that tries to match Iterable.iterator() as much as possible,
but return each distinct element only once
and therefore it might not respect the configuration of this EntitySelector entirely.
endingIterator in interface EntitySelectorIterable.iterator()public String toString()
toString in class Object
|
OptaPlanner distribution 6.1.0.CR2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||