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

Class NearEntityNearbyEntitySelector<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_,EntitySelector<Solution_>,EntitySelector<Solution_>>

ai.timefold.solver.core.impl.heuristic.selector.entity.nearby.NearEntityNearbyEntitySelector<Solution_>

All Implemented Interfaces:

ListIterable<Object>, EntitySelector<Solution_>, IterableSelector<Solution_,Object>, ListIterableSelector<Solution_,Object>, Selector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>, Iterable<Object>, EventListener

public final class NearEntityNearbyEntitySelector<Solution_>
extends AbstractNearbySelector<Solution_,EntitySelector<Solution_>,EntitySelector<Solution_>>
implements EntitySelector<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
NearEntityNearbyEntitySelector(EntitySelector<Solution_> childEntitySelector, EntitySelector<Solution_> originEntitySelector, NearbyDistanceMeter<?,?> nearbyDistanceMeter, NearbyRandom nearbyRandom, boolean randomSelection)

Method Summary

Modifier and Type	Method	Description
protected EntitySelector<Solution_>	castReplayingSelector(Object uncastReplayingSelector)
protected AbstractNearbyDistanceMatrixDemand<?,?,?,?>	createDemand()
Iterator<Object>	endingIterator()	If Selector.isNeverEnding() is true, then Iterable.iterator() will never end.
EntityDescriptor<Solution_>	getEntityDescriptor()
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.
boolean	isCountable()	If false, then Selector.isNeverEnding() is true.
Iterator<Object>	iterator()
ListIterator<Object>	listIterator()
ListIterator<Object>	listIterator(int index)

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

NearEntityNearbyEntitySelector

public NearEntityNearbyEntitySelector(EntitySelector<Solution_> childEntitySelector,
                                      EntitySelector<Solution_> originEntitySelector,
                                      NearbyDistanceMeter<?,?> nearbyDistanceMeter,
                                      NearbyRandom nearbyRandom,
                                      boolean randomSelection)

Method Detail

castReplayingSelector

protected EntitySelector<Solution_> castReplayingSelector(Object uncastReplayingSelector)

Specified by:

castReplayingSelector in class AbstractNearbySelector<Solution_,EntitySelector<Solution_>,EntitySelector<Solution_>>

createDemand

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

Specified by:

createDemand in class AbstractNearbySelector<Solution_,EntitySelector<Solution_>,EntitySelector<Solution_>>

getEntityDescriptor

public EntityDescriptor<Solution_> getEntityDescriptor()

Specified by:

getEntityDescriptor in interface EntitySelector<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)

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

Specified by:

iterator in interface Iterable<Solution_>

listIterator

public ListIterator<Object> listIterator()

Specified by:

listIterator in interface ListIterable<Solution_>

Returns:

never null, see List.listIterator().

See Also:

List.listIterator()

listIterator

public ListIterator<Object> listIterator(int index)

Specified by:

listIterator in interface ListIterable<Solution_>

Parameters:

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

Returns:

never null, see List.listIterator(int).

See Also:

List.listIterator()

endingIterator

public Iterator<Object> endingIterator()

Description copied from interface: EntitySelector

If Selector.isNeverEnding() is true, then Iterable.iterator() will never end. This returns an ending Iterator, that tries to match Iterable.iterator() as much as possible, but returns each distinct element only once and returns every element that might possibly be selected and therefore it might not respect the configuration of this EntitySelector entirely.

Specified by:

endingIterator in interface EntitySelector<Solution_>

Returns:

never null

See Also:

Iterable.iterator()