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

Class IterableFromEntityPropertyValueSelector<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.IterableFromEntityPropertyValueSelector<Solution_>

Type Parameters:

Solution_ - the solution type

All Implemented Interfaces:

IterableSelector<Solution_,Object>, Selector<Solution_>, IterableValueSelector<Solution_>, ValueSelector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>, Iterable<Object>, EventListener

public final class IterableFromEntityPropertyValueSelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements IterableValueSelector<Solution_>

The value range for list variables requires the selector to be entity-independent, as it needs to fetch the entire list of values. Fetching the list of values is not a problem when the value range is located within the solution class, serving as a single source of truth. In cases where it is entity-dependent, the list of entities must be read to generate the corresponding list of values.

This selector adapts FromEntityPropertyValueSelector to behave like an entity-independent selector and meets the requirement to retrieve the complete list of values.

Field Summary

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
IterableFromEntityPropertyValueSelector(FromEntityPropertyValueSelector<Solution_> childValueSelector, boolean randomSelection)
IterableFromEntityPropertyValueSelector(FromEntityPropertyValueSelector<Solution_> childValueSelector, SelectionCacheType minimumCacheType, boolean randomSelection)

Method Summary

Modifier and Type	Method	Description
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.
FromEntityPropertyValueSelector<Solution_>	getChildValueSelector()
SelectionSorter<Solution_,Object>	getSelectionSorter()	Returns the selection sorter applied to the node.
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.
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.
boolean	isNeverEnding()	Is true if Selector.isCountable() is false or if this selector is in random order (for most cases).
Iterator<Object>	iterator()
Iterator<Object>	iterator(Object entity)	Similar to Iterable.iterator(), but requires an entity.
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingStarted(SolverScope<Solution_> solverScope)

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

stepEnded, stepStarted

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, 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

stepEnded, stepStarted

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

solvingError

Constructor Details

IterableFromEntityPropertyValueSelector

public IterableFromEntityPropertyValueSelector(FromEntityPropertyValueSelector<Solution_> childValueSelector,
 boolean randomSelection)

IterableFromEntityPropertyValueSelector

public IterableFromEntityPropertyValueSelector(FromEntityPropertyValueSelector<Solution_> childValueSelector,
 SelectionCacheType minimumCacheType,
 boolean randomSelection)

Method Details

solvingStarted

public void solvingStarted(SolverScope<Solution_> solverScope)

Specified by:

solvingStarted in interface SolverLifecycleListener<Solution_>

Overrides:

solvingStarted in class AbstractSelector<Solution_>

solvingEnded

public void solvingEnded(SolverScope<Solution_> solverScope)

Specified by:

solvingEnded in interface SolverLifecycleListener<Solution_>

Overrides:

solvingEnded in class AbstractSelector<Solution_>

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseStarted in class AbstractSelector<Solution_>

phaseEnded

public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseEnded in class AbstractSelector<Solution_>

getChildValueSelector

public FromEntityPropertyValueSelector<Solution_> getChildValueSelector()

getSelectionSorter

public SelectionSorter<Solution_,Object> getSelectionSorter()

Description copied from interface: ValueSelector

Returns the selection sorter applied to the node. By default, it returns null and must be overridden by the child class if necessary.

Specified by:

getSelectionSorter in interface ValueSelector<Solution_>

Returns:

the selection sorter.

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

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface ValueSelector<Solution_>

Returns:

never null

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

iterator

public Iterator<Object> iterator(Object entity)

Description copied from interface: ValueSelector

Similar to Iterable.iterator(), but requires an entity.

Specified by:

iterator in interface ValueSelector<Solution_>

Parameters:

entity - never null

Returns:

never null

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)

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

equals

public boolean equals(Object other)

Specified by:

equals in class AbstractDemandEnabledSelector<Solution_>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractDemandEnabledSelector<Solution_>