Package ai.timefold.solver.core.impl.heuristic.selector.list

Class RandomSubListSelector<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector<Solution_>

ai.timefold.solver.core.impl.heuristic.selector.list.RandomSubListSelector<Solution_>

All Implemented Interfaces:

IterableSelector<Solution_,SubList>, SubListSelector<Solution_>, Selector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>, Iterable<SubList>, EventListener

public class RandomSubListSelector<Solution_>
extends AbstractSelector<Solution_>
implements SubListSelector<Solution_>

Field Summary

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
RandomSubListSelector(EntitySelector<Solution_> entitySelector, EntityIndependentValueSelector<Solution_> valueSelector, int minimumSubListSize, int maximumSubListSize)

Method Summary

Modifier and Type	Method	Description
Iterator<Object>	endingValueIterator()
int	getMaximumSubListSize()
int	getMinimumSubListSize()
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	getValueCount()
ListVariableDescriptor<Solution_>	getVariableDescriptor()
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<SubList>	iterator()
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingStarted(SolverScope<Solution_> solverScope)
String	toString()

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

getCacheType, phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

phaseEnded, phaseStarted, stepEnded, stepStarted

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

getCacheType

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

solvingError

Constructor Detail

RandomSubListSelector

public RandomSubListSelector(EntitySelector<Solution_> entitySelector,
                             EntityIndependentValueSelector<Solution_> valueSelector,
                             int minimumSubListSize,
                             int maximumSubListSize)

Method Detail

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

getVariableDescriptor

public ListVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface SubListSelector<Solution_>

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

Returns:

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

endingValueIterator

public Iterator<Object> endingValueIterator()

Specified by:

endingValueIterator in interface SubListSelector<Solution_>

getValueCount

public long getValueCount()

Specified by:

getValueCount in interface SubListSelector<Solution_>

iterator

public Iterator<SubList> iterator()

Specified by:

iterator in interface Iterable<Solution_>

getMinimumSubListSize

public int getMinimumSubListSize()

getMaximumSubListSize

public int getMaximumSubListSize()

toString

public String toString()

Overrides:

toString in class Object