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

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

All Implemented Interfaces:

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

public final class SelectedCountLimitValueSelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements EntityIndependentValueSelector<Solution_>

Field Summary

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
SelectedCountLimitValueSelector(ValueSelector<Solution_> childValueSelector, long selectedCountLimit)	Unlike most of the other ValueSelector decorations, this one works for an entity dependent ValueSelector too.

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)
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.
String	toString()

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

getCacheType, 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

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

solvingEnded, solvingError, solvingStarted

Constructor Detail

SelectedCountLimitValueSelector

public SelectedCountLimitValueSelector(ValueSelector<Solution_> childValueSelector,
                                       long selectedCountLimit)

Unlike most of the other ValueSelector decorations, this one works for an entity dependent ValueSelector too.

Parameters:

childValueSelector - never null, if any of the EntityIndependentValueSelector specific methods are going to be used, this parameter must also implement that interface

selectedCountLimit - at least 0

Method Detail

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface ValueSelector<Solution_>

Returns:

never null

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

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

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)

equals

public boolean equals(Object other)

Specified by:

equals in class AbstractDemandEnabledSelector<Solution_>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractDemandEnabledSelector<Solution_>

toString

public String toString()

Overrides:

toString in class Object