Class FilteringEntityByValueSelector<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.FilteringEntityByValueSelector<Solution_>
- Type Parameters:
Solution_- the solution type
- All Implemented Interfaces:
ListIterable<Object>,EntitySelector<Solution_>,IterableSelector<Solution_,,Object> ListIterableSelector<Solution_,,Object> Selector<Solution_>,PhaseLifecycleListener<Solution_>,SolverLifecycleListener<Solution_>,Iterable<Object>,EventListener
public final class FilteringEntityByValueSelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements EntitySelector<Solution_>
The decorator returns a list of reachable entities for a specific value.
It enables the creation of a filtering tier when using entity-provided value ranges,
ensuring only valid and reachable entities are returned.
An entity is considered reachable to a value if its value range includes that value.
The decorator can only be applied to list variables.
e1 = entity_range[v1, v2, v3] e2 = entity_range[v1, v4] v1 = [e1, e2] v2 = [e1] v3 = [e1] v4 = [e2]
This node is currently used by the QueuedValuePlacer to build an initial solution.
To illustrate its usage, let’s assume how moves are generated.
First, a value is selected using a value selector.
Then,
a change move selector generates all possible moves for that value to the available entities
and selects the entity and position with the best score.
Considering the previous process and the current goal of this node, we can observe that once a value is selected, only change moves to reachable entities will be generated. This ensures that entities that do not accept the currently selected value will not produce any change moves.
-
Field Summary
Fields inherited from class ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom -
Constructor Summary
ConstructorsConstructorDescriptionFilteringEntityByValueSelector(EntitySelector<Solution_> childEntitySelector, IterableValueSelector<Solution_> replayingValueSelector, boolean randomSelection, boolean isExhaustiveSearch) -
Method Summary
Modifier and TypeMethodDescriptionIfSelector.isNeverEnding()is true, thenIterable.iterator()will never end.booleanlonggetSize()A random JITSelectorwithSelector.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 inSelectionProbabilityWeightFactory.inthashCode()booleanIf false, thenSelector.isNeverEnding()is true.booleanIs true ifSelector.isCountable()is false or if this selector is in random order (for most cases).iterator()listIterator(int index) voidphaseEnded(AbstractPhaseScope<Solution_> phaseScope) voidphaseStarted(AbstractPhaseScope<Solution_> phaseScope) voidsolvingStarted(SolverScope<Solution_> solverScope) voidstepStarted(AbstractStepScope<Solution_> stepScope) Methods inherited from class ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector
getCacheType, solvingEnded, stepEndedMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ai.timefold.solver.core.impl.heuristic.selector.IterableSelector
spliteratorMethods inherited from interface ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListener
stepEndedMethods inherited from interface ai.timefold.solver.core.impl.heuristic.selector.Selector
getCacheTypeMethods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingError
-
Constructor Details
-
FilteringEntityByValueSelector
public FilteringEntityByValueSelector(EntitySelector<Solution_> childEntitySelector, IterableValueSelector<Solution_> replayingValueSelector, boolean randomSelection, boolean isExhaustiveSearch)
-
-
Method Details
-
solvingStarted
- Specified by:
solvingStartedin interfaceSolverLifecycleListener<Solution_>- Overrides:
solvingStartedin classAbstractSelector<Solution_>
-
phaseStarted
- Specified by:
phaseStartedin interfacePhaseLifecycleListener<Solution_>- Overrides:
phaseStartedin classAbstractSelector<Solution_>
-
phaseEnded
- Specified by:
phaseEndedin interfacePhaseLifecycleListener<Solution_>- Overrides:
phaseEndedin classAbstractSelector<Solution_>
-
stepStarted
- Specified by:
stepStartedin interfacePhaseLifecycleListener<Solution_>- Overrides:
stepStartedin classAbstractSelector<Solution_>
-
getChildEntitySelector
-
getEntityDescriptor
- Specified by:
getEntityDescriptorin interfaceEntitySelector<Solution_>- Returns:
- never null
-
getSize
public long getSize()Description copied from interface:IterableSelectorA random JITSelectorwithSelector.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 inSelectionProbabilityWeightFactory.- Specified by:
getSizein interfaceIterableSelector<Solution_,Object> - Returns:
- the approximate number of elements generated by this
Selector, always>= 0
-
isCountable
public boolean isCountable()Description copied from interface:SelectorIf false, thenSelector.isNeverEnding()is true.- Specified by:
isCountablein interfaceSelector<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:SelectorIs true ifSelector.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:
isNeverEndingin interfaceSelector<Solution_>- Returns:
- true if the
Iterator.hasNext()of theIteratorcreated byIterable.iterator()never returns false (except when it's empty).
-
endingIterator
Description copied from interface:EntitySelectorIfSelector.isNeverEnding()is true, thenIterable.iterator()will never end. This returns an endingIterator, that tries to matchIterable.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 thisEntitySelectorentirely.- Specified by:
endingIteratorin interfaceEntitySelector<Solution_>- Returns:
- never null
- See Also:
-
iterator
-
listIterator
- Specified by:
listIteratorin interfaceListIterable<Solution_>- Returns:
- never null, see
List.listIterator(). - See Also:
-
listIterator
- Specified by:
listIteratorin interfaceListIterable<Solution_>- Parameters:
index- lower than the size of thisListIterable, seeList.listIterator(int).- Returns:
- never null, see
List.listIterator(int). - See Also:
-
equals
- Specified by:
equalsin classAbstractDemandEnabledSelector<Solution_>
-
hashCode
public int hashCode()- Specified by:
hashCodein classAbstractDemandEnabledSelector<Solution_>
-