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

Class NearEntityNearbyValueSelector<Solution_>

java.lang.Object

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

org.optaplanner.core.impl.heuristic.selector.value.AbstractValueSelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.value.nearby.NearEntityNearbyValueSelector<Solution_>

All Implemented Interfaces:

EventListener, Selector<Solution_>, ValueSelector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>

public final class NearEntityNearbyValueSelector<Solution_>
extends AbstractValueSelector<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected ValueSelector<Solution_>	childValueSelector
protected boolean	discardNearbyIndexZero
protected NearbyDistanceMatrix	nearbyDistanceMatrix
protected NearbyDistanceMeter<?,?>	nearbyDistanceMeter
protected NearbyRandom	nearbyRandom
protected boolean	randomSelection
protected EntitySelector<Solution_>	replayingOriginEntitySelector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
NearEntityNearbyValueSelector(ValueSelector<Solution_> childValueSelector, EntitySelector<Solution_> originEntitySelector, NearbyDistanceMeter<?,?> nearbyDistanceMeter, NearbyRandom nearbyRandom, boolean randomSelection)

Method Summary

Modifier and Type	Method	Description
Iterator<Object>	endingIterator(Object entity)	If Selector.isNeverEnding() is true, then ValueSelector.iterator(Object) will never end.
long	getSize(Object entity)	Similar to IterableSelector.getSize(), but requires an entity.
GenuineVariableDescriptor<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<Object>	iterator(Object entity)	Similar to Iterable.iterator(), but requires an entity.
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
String	toString()

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

getCacheType, solvingEnded, solvingStarted, stepEnded, stepStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

stepEnded, stepStarted

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

getCacheType

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

solvingEnded, solvingError, solvingStarted

Field Detail

childValueSelector

protected final ValueSelector<Solution_> childValueSelector

replayingOriginEntitySelector

protected final EntitySelector<Solution_> replayingOriginEntitySelector

nearbyDistanceMeter

protected final NearbyDistanceMeter<?,?> nearbyDistanceMeter

nearbyRandom

protected final NearbyRandom nearbyRandom

randomSelection

protected final boolean randomSelection

discardNearbyIndexZero

protected final boolean discardNearbyIndexZero

nearbyDistanceMatrix

protected NearbyDistanceMatrix nearbyDistanceMatrix

Constructor Detail

NearEntityNearbyValueSelector

public NearEntityNearbyValueSelector(ValueSelector<Solution_> childValueSelector,
                                     EntitySelector<Solution_> originEntitySelector,
                                     NearbyDistanceMeter<?,?> nearbyDistanceMeter,
                                     NearbyRandom nearbyRandom,
                                     boolean randomSelection)

Method Detail

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Returns:

never null

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseStarted in class AbstractSelector<Solution_>

phaseEnded

public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseEnded in class AbstractSelector<Solution_>

isCountable

public boolean isCountable()

Description copied from interface: Selector

If false, then Selector.isNeverEnding() is true.

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

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.

Parameters:

entity - never null

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.

Parameters:

entity - never null

Returns:

never null

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.

Parameters:

entity - never null

Returns:

never null

See Also:

ValueSelector.iterator(Object)

toString

public String toString()

Overrides:

toString in class Object