Package org.optaplanner.core.impl.heuristic.selector.entity.decorator

Class ProbabilityEntitySelector

java.lang.Object

org.optaplanner.core.impl.heuristic.selector.AbstractSelector

org.optaplanner.core.impl.heuristic.selector.entity.AbstractEntitySelector

org.optaplanner.core.impl.heuristic.selector.entity.decorator.ProbabilityEntitySelector

All Implemented Interfaces:

Iterable<Object>, EventListener, ListIterable<Object>, SelectionCacheLifecycleListener, EntitySelector, IterableSelector<Object>, ListIterableSelector<Object>, Selector, PhaseLifecycleListener, SolverLifecycleListener

public class ProbabilityEntitySelector
extends AbstractEntitySelector
implements SelectionCacheLifecycleListener

Field Summary

Fields

Modifier and Type	Field	Description
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

Constructors

Constructor	Description
ProbabilityEntitySelector(EntitySelector childEntitySelector, SelectionCacheType cacheType, SelectionProbabilityWeightFactory probabilityWeightFactory)

Method Summary

Modifier and Type	Method	Description
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()
ListIterator<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

childEntitySelector

protected final EntitySelector childEntitySelector

cacheType

protected final SelectionCacheType cacheType

probabilityWeightFactory

protected final SelectionProbabilityWeightFactory probabilityWeightFactory

cachedEntityMap

protected NavigableMap<Double,Object> cachedEntityMap

probabilityWeightTotal

protected double probabilityWeightTotal

Constructor Detail

ProbabilityEntitySelector

public ProbabilityEntitySelector(EntitySelector childEntitySelector,
                                 SelectionCacheType cacheType,
                                 SelectionProbabilityWeightFactory probabilityWeightFactory)

Method Detail

getCacheType

public SelectionCacheType getCacheType()

Description copied from interface: Selector

Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.

Specified by:

getCacheType in interface Selector

Overrides:

getCacheType in class AbstractSelector

Returns:

never null

constructCache

public void constructCache(DefaultSolverScope solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener

disposeCache

public void disposeCache(DefaultSolverScope solverScope)

Specified by:

disposeCache in interface SelectionCacheLifecycleListener

getEntityDescriptor

public EntityDescriptor getEntityDescriptor()

Specified by:

getEntityDescriptor in interface EntitySelector

Returns:

never null

isCountable

public boolean isCountable()

Description copied from interface: Selector

If false, then Selector.isNeverEnding() is true.

Specified by:

isCountable in interface Selector

Returns:

true if all the ValueRanges 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 if Selector.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 interface Selector

Returns:

true if the Iterator.hasNext() of the Iterator created by Iterable.iterator() never returns false (except when it's empty).

getSize

public long getSize()

Description copied from interface: IterableSelector

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.

Specified by:

getSize in interface IterableSelector<Object>

Returns:

the approximate number of elements generated by this Selector, always >= 0

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Object>

listIterator

public ListIterator<Object> listIterator()

Specified by:

listIterator in interface ListIterable<Object>

Returns:

never null, see List.listIterator().

See Also:

List.listIterator()

listIterator

public ListIterator<Object> listIterator(int index)

Specified by:

listIterator in interface ListIterable<Object>

Parameters:

index - lower than the size of this ListIterable, see List.listIterator(int).

Returns:

never null, see List.listIterator(int).

See Also:

List.listIterator()

endingIterator

public Iterator<Object> endingIterator()

Description copied from interface: EntitySelector

If Selector.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 returns each distinct element only once and returns every element that might possibly be selected and therefore it might not respect the configuration of this EntitySelector entirely.

Specified by:

endingIterator in interface EntitySelector

Returns:

never null

See Also:

Iterable.iterator()

toString

public String toString()

Overrides:

toString in class Object