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

Class SortingEntitySelector<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.AbstractCachingEntitySelector<Solution_>

ai.timefold.solver.core.impl.heuristic.selector.entity.decorator.SortingEntitySelector<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 SortingEntitySelector<Solution_>
extends AbstractCachingEntitySelector<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.heuristic.selector.entity.decorator.AbstractCachingEntitySelector

cachedEntityList, cacheType, childEntitySelector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
SortingEntitySelector(EntitySelector<Solution_> childEntitySelector, SelectionCacheType cacheType, SelectionSorter<Solution_,Object> sorter)

Method Summary

Modifier and Type	Method	Description
void	constructCache(SolverScope<Solution_> solverScope)
boolean	equals(Object o)
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	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)
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
String	toString()

Methods inherited from class ai.timefold.solver.core.impl.heuristic.selector.entity.decorator.AbstractCachingEntitySelector

disposeCache, endingIterator, getCacheType, getChildEntitySelector, getEntityDescriptor, isCountable

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

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

stepEnded, stepStarted

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

solvingEnded, solvingError, solvingStarted

Constructor Details

SortingEntitySelector

public SortingEntitySelector(EntitySelector<Solution_> childEntitySelector,
 SelectionCacheType cacheType,
 SelectionSorter<Solution_,Object> sorter)

Method Details

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

constructCache

public void constructCache(SolverScope<Solution_> solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener<Solution_>

Overrides:

constructCache in class AbstractCachingEntitySelector<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).

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>

Overrides:

getSize in class AbstractCachingEntitySelector<Solution_>

Returns:

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

iterator

public Iterator<Object> iterator()

listIterator

public ListIterator<Object> listIterator()

Returns:

never null, see List.listIterator().

See Also:

• List.listIterator()

listIterator

public ListIterator<Object> listIterator(int index)

Parameters:

index - lower than the size of this ListIterable, see List.listIterator(int).

Returns:

never null, see List.listIterator(int).

See Also:

• List.listIterator()

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractCachingEntitySelector<Solution_>

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractCachingEntitySelector<Solution_>

toString

public String toString()

Overrides:

toString in class Object