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

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

ai.timefold.solver.core.impl.heuristic.selector.value.decorator.SortingValueSelector<Solution_>

All Implemented Interfaces:

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

public final class SortingValueSelector<Solution_>
extends AbstractCachingValueSelector<Solution_>
implements EntityIndependentValueSelector<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SelectionSorter<Solution_,Object>	sorter

Fields inherited from class ai.timefold.solver.core.impl.heuristic.selector.value.decorator.AbstractCachingValueSelector

cachedValueList, cacheType, childValueSelector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
SortingValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector, SelectionCacheType cacheType, SelectionSorter<Solution_,Object> sorter)

Method Summary

Modifier and Type	Method	Description
void	constructCache(SolverScope<Solution_> solverScope)
boolean	equals(Object other)
int	hashCode()
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.
String	toString()

Methods inherited from class ai.timefold.solver.core.impl.heuristic.selector.value.decorator.AbstractCachingValueSelector

disposeCache, endingIterator, endingIterator, getCacheType, getChildValueSelector, getSize, getSize, getVariableDescriptor, isCountable

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

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

getCacheType, isCountable

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

endingIterator, getSize, getVariableDescriptor

Field Details

sorter

protected final SelectionSorter<Solution_,Object> sorter

Constructor Details

SortingValueSelector

public SortingValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector,
 SelectionCacheType cacheType,
 SelectionSorter<Solution_,Object> sorter)

Method Details

constructCache

public void constructCache(SolverScope<Solution_> solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener<Solution_>

Overrides:

constructCache in class AbstractCachingValueSelector<Solution_>

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).

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

iterator

public Iterator<Object> iterator()

Specified by:

iterator in interface Iterable<Solution_>

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractCachingValueSelector<Solution_>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCachingValueSelector<Solution_>

toString

public String toString()

Overrides:

toString in class Object