Package org.optaplanner.core.impl.heuristic.selector.list.nearby

Class NearSubListNearbySubListSelector<Solution_>

java.lang.Object

org.optaplanner.core.impl.heuristic.selector.AbstractSelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.AbstractDemandEnabledSelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.common.nearby.AbstractNearbySelector<Solution_,RandomSubListSelector<Solution_>,MimicReplayingSubListSelector<Solution_>>

org.optaplanner.core.impl.heuristic.selector.list.nearby.NearSubListNearbySubListSelector<Solution_>

All Implemented Interfaces:

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

public final class NearSubListNearbySubListSelector<Solution_>
extends AbstractNearbySelector<Solution_,RandomSubListSelector<Solution_>,MimicReplayingSubListSelector<Solution_>>
implements SubListSelector<Solution_>

Field Summary

Fields inherited from class org.optaplanner.core.impl.heuristic.selector.common.nearby.AbstractNearbySelector

childSelector, nearbyDistanceMatrix, nearbyDistanceMeter, nearbyRandom, randomSelection, replayingSelector

Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
NearSubListNearbySubListSelector(RandomSubListSelector<Solution_> childSubListSelector, SubListSelector<Solution_> originSubListSelector, NearbyDistanceMeter<?,?> nearbyDistanceMeter, NearbyRandom nearbyRandom)

Method Summary

Modifier and Type	Method	Description
protected MimicReplayingSubListSelector<Solution_>	castReplayingSelector(Object uncastReplayingSelector)
protected AbstractNearbyDistanceMatrixDemand<?,?,?,?>	createDemand()
Iterator<Object>	endingValueIterator()
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.
Iterator<SubList>	iterator()
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingStarted(SolverScope<Solution_> solverScope)

Methods inherited from class org.optaplanner.core.impl.heuristic.selector.common.nearby.AbstractNearbySelector

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

Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

getCacheType, 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 org.optaplanner.core.impl.heuristic.selector.IterableSelector

spliterator

Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.Selector

getCacheType, isNeverEnding

Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener

solvingError

Constructor Details

NearSubListNearbySubListSelector

public NearSubListNearbySubListSelector(RandomSubListSelector<Solution_> childSubListSelector,
 SubListSelector<Solution_> originSubListSelector,
 NearbyDistanceMeter<?,?> nearbyDistanceMeter,
 NearbyRandom nearbyRandom)

Method Details

castReplayingSelector

protected MimicReplayingSubListSelector<Solution_> castReplayingSelector(Object uncastReplayingSelector)

Specified by:

castReplayingSelector in class AbstractNearbySelector<Solution_,RandomSubListSelector<Solution_>,MimicReplayingSubListSelector<Solution_>>

createDemand

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

Specified by:

createDemand in class AbstractNearbySelector<Solution_,RandomSubListSelector<Solution_>,MimicReplayingSubListSelector<Solution_>>

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

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

Returns:

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

iterator

public Iterator<SubList> iterator()

Specified by:

iterator in interface Iterable<Solution_>

getVariableDescriptor

public ListVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface SubListSelector<Solution_>

endingValueIterator

public Iterator<Object> endingValueIterator()

Specified by:

endingValueIterator in interface SubListSelector<Solution_>

getValueCount

public long getValueCount()

Specified by:

getValueCount in interface SubListSelector<Solution_>