Package ai.timefold.solver.core.impl.heuristic.selector.entity.decorator

Class ProbabilityEntitySelector<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector<Solution_>

ai.timefold.solver.core.impl.heuristic.selector.AbstractDemandEnabledSelector<Solution_>

ai.timefold.solver.core.impl.heuristic.selector.entity.decorator.ProbabilityEntitySelector<Solution_>

All Implemented Interfaces:

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

public final class ProbabilityEntitySelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements SelectionCacheLifecycleListener<Solution_>, EntitySelector<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
ProbabilityEntitySelector(EntitySelector<Solution_> childEntitySelector, SelectionCacheType cacheType, SelectionProbabilityWeightFactory<Solution_,Object> probabilityWeightFactory)

Method Summary

Modifier and Type	Method	Description
void	constructCache(SolverScope<Solution_> solverScope)
void	disposeCache(SolverScope<Solution_> solverScope)
Iterator<Object>	endingIterator()	If Selector.isNeverEnding() is true, then Iterable.iterator() will never end.
boolean	equals(Object other)
SelectionCacheType	getCacheType()	Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.
EntityDescriptor<Solution_>	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.
int	hashCode()
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 ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector

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 java.lang.Iterable

forEach

Methods inherited from interface ai.timefold.solver.core.impl.heuristic.selector.IterableSelector

spliterator

Methods inherited from interface ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener

solvingEnded, solvingError, solvingStarted

Constructor Details

ProbabilityEntitySelector

public ProbabilityEntitySelector(EntitySelector<Solution_> childEntitySelector,
 SelectionCacheType cacheType,
 SelectionProbabilityWeightFactory<Solution_,Object> probabilityWeightFactory)

Method Details

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<Solution_>

Overrides:

getCacheType in class AbstractSelector<Solution_>

Returns:

never null

constructCache

public void constructCache(SolverScope<Solution_> solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener<Solution_>

disposeCache

public void disposeCache(SolverScope<Solution_> solverScope)

Specified by:

disposeCache in interface SelectionCacheLifecycleListener<Solution_>

getEntityDescriptor

public EntityDescriptor<Solution_> getEntityDescriptor()

Specified by:

getEntityDescriptor in interface EntitySelector<Solution_>

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<Solution_>

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<Solution_>

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<Solution_,Object>

Returns:

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

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Solution_>

listIterator

public ListIterator<Object> listIterator()

Specified by:

listIterator in interface ListIterable<Solution_>

Returns:

never null, see List.listIterator().

See Also:

• List.listIterator()

listIterator

public ListIterator<Object> listIterator(int index)

Specified by:

listIterator in interface ListIterable<Solution_>

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<Solution_>

Returns:

never null

See Also:

• Iterable.iterator()

equals

public boolean equals(Object other)

Specified by:

equals in class AbstractDemandEnabledSelector<Solution_>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractDemandEnabledSelector<Solution_>

toString

public String toString()

Overrides:

toString in class Object