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

Class NearValueNearbyValueSelector<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.common.nearby.AbstractNearbySelector<Solution_,ChildSelector_,ReplayingSelector_>

ai.timefold.solver.core.impl.heuristic.selector.value.nearby.NearValueNearbyValueSelector<Solution_>

All Implemented Interfaces:

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

public final class NearValueNearbyValueSelector<Solution_>
extends AbstractNearbySelector<Solution_,ChildSelector_,ReplayingSelector_>
implements EntityIndependentValueSelector<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.heuristic.selector.common.nearby.AbstractNearbySelector

childSelector, nearbyDistanceMatrix, nearbyDistanceMeter, nearbyRandom, randomSelection, replayingSelector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
NearValueNearbyValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector, EntityIndependentValueSelector<Solution_> originValueSelector, NearbyDistanceMeter<?,?> nearbyDistanceMeter, NearbyRandom nearbyRandom, boolean randomSelection)

Method Summary

Modifier and Type	Method	Description
protected MimicReplayingValueSelector<Solution_>	castReplayingSelector(Object uncastReplayingSelector)
protected AbstractNearbyDistanceMatrixDemand<?,?,?,?>	createDemand()
Iterator<Object>	endingIterator(Object entity)	If Selector.isNeverEnding() is true, then ValueSelector.iterator(Object) will never end.
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()
boolean	isCountable()	If false, then Selector.isNeverEnding() is true.
Iterator<Object>	iterator()
Iterator<Object>	iterator(Object entity)	Similar to Iterable.iterator(), but requires an entity.

Methods inherited from class ai.timefold.solver.core.impl.heuristic.selector.common.nearby.AbstractNearbySelector

equals, getNearbyDistanceMatrixDemand, hashCode, isNeverEnding, phaseEnded, phaseStarted, toString

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

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

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

solvingEnded, solvingError, solvingStarted

Constructor Detail

NearValueNearbyValueSelector

public NearValueNearbyValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector,
                                    EntityIndependentValueSelector<Solution_> originValueSelector,
                                    NearbyDistanceMeter<?,?> nearbyDistanceMeter,
                                    NearbyRandom nearbyRandom,
                                    boolean randomSelection)

Method Detail

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface ValueSelector<Solution_>

Returns:

never null

castReplayingSelector

protected MimicReplayingValueSelector<Solution_> castReplayingSelector(Object uncastReplayingSelector)

Specified by:

castReplayingSelector in class AbstractNearbySelector<Solution_,EntityIndependentValueSelector<Solution_>,MimicReplayingValueSelector<Solution_>>

createDemand

protected AbstractNearbyDistanceMatrixDemand<?,?,?,?> createDemand()

Specified by:

createDemand in class AbstractNearbySelector<Solution_,EntityIndependentValueSelector<Solution_>,MimicReplayingValueSelector<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)

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)