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

Class AbstractCachingValueSelector<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.value.decorator.AbstractCachingValueSelector<Solution_>

All Implemented Interfaces:

SelectionCacheLifecycleListener<Solution_>, Selector<Solution_>, ValueSelector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>, EventListener

Direct Known Subclasses:

CachingValueSelector, ShufflingValueSelector, SortingValueSelector

public abstract class AbstractCachingValueSelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements SelectionCacheLifecycleListener<Solution_>, ValueSelector<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Object>	cachedValueList
protected final SelectionCacheType	cacheType
protected final EntityIndependentValueSelector<Solution_>	childValueSelector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
AbstractCachingValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector, SelectionCacheType cacheType)

Method Summary

Modifier and Type	Method	Description
void	constructCache(SolverScope<Solution_> solverScope)
void	disposeCache(SolverScope<Solution_> solverScope)
Iterator<Object>	endingIterator()
Iterator<Object>	endingIterator(Object entity)	If Selector.isNeverEnding() is true, then ValueSelector.iterator(Object) 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.
ValueSelector<Solution_>	getChildValueSelector()
long	getSize()
long	getSize(Object entity)	Similar to IterableSelector.getSize(), but requires an entity.
GenuineVariableDescriptor<Solution_>	getVariableDescriptor()
int	hashCode()
boolean	isCountable()	If false, then Selector.isNeverEnding() is true.

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, toString, wait, wait, wait

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.heuristic.selector.Selector

isNeverEnding

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

solvingEnded, solvingError, solvingStarted

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

iterator

Field Details

childValueSelector

protected final EntityIndependentValueSelector<Solution_> childValueSelector

cacheType

protected final SelectionCacheType cacheType

cachedValueList

protected List<Object> cachedValueList

Constructor Details

AbstractCachingValueSelector

public AbstractCachingValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector,
 SelectionCacheType cacheType)

Method Details

getChildValueSelector

public ValueSelector<Solution_> getChildValueSelector()

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

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface ValueSelector<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)

getSize

public long getSize(Object entity)

Description copied from interface: ValueSelector

Similar to IterableSelector.getSize(), but requires an entity.

Specified by:

getSize in interface ValueSelector<Solution_>

Parameters:

entity - never null

Returns:

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

getSize

public long getSize()

endingIterator

public Iterator<Object> endingIterator(Object entity)

Description copied from interface: ValueSelector

If Selector.isNeverEnding() is true, then ValueSelector.iterator(Object) will never end. This returns an ending Iterator, that tries to match ValueSelector.iterator(Object) as much as possible, but return each distinct element only once and therefore it might not respect the configuration of this ValueSelector entirely.

Specified by:

endingIterator in interface ValueSelector<Solution_>

Parameters:

entity - never null

Returns:

never null

See Also:

• ValueSelector.iterator(Object)

endingIterator

public Iterator<Object> endingIterator()

equals

public boolean equals(Object other)

Specified by:

equals in class AbstractDemandEnabledSelector<Solution_>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractDemandEnabledSelector<Solution_>