Class NearEntityNearbyEntitySelector
- java.lang.Object
-
- org.optaplanner.core.impl.heuristic.selector.AbstractSelector
-
- org.optaplanner.core.impl.heuristic.selector.entity.AbstractEntitySelector
-
- org.optaplanner.core.impl.heuristic.selector.entity.nearby.NearEntityNearbyEntitySelector
-
- All Implemented Interfaces:
Iterable<Object>
,EventListener
,ListIterable<Object>
,EntitySelector
,IterableSelector<Object>
,ListIterableSelector<Object>
,Selector
,PhaseLifecycleListener
,SolverLifecycleListener
public class NearEntityNearbyEntitySelector extends AbstractEntitySelector
-
-
Field Summary
Fields Modifier and Type Field Description protected EntitySelector
childEntitySelector
protected boolean
discardNearbyIndexZero
protected NearbyDistanceMatrix
nearbyDistanceMatrix
protected NearbyDistanceMeter
nearbyDistanceMeter
protected NearbyRandom
nearbyRandom
protected EntitySelector
originEntitySelector
protected boolean
randomSelection
-
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
-
Constructor Summary
Constructors Constructor Description NearEntityNearbyEntitySelector(EntitySelector childEntitySelector, EntitySelector originEntitySelector, NearbyDistanceMeter nearbyDistanceMeter, NearbyRandom nearbyRandom, boolean randomSelection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterator<Object>
endingIterator()
IfSelector.isNeverEnding()
is true, thenIterable.iterator()
will never end.EntityDescriptor
getEntityDescriptor()
long
getSize()
A random JITSelector
withSelector.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 inSelectionProbabilityWeightFactory
.boolean
isCountable()
If false, thenSelector.isNeverEnding()
is true.boolean
isNeverEnding()
Is true ifSelector.isCountable()
is false or if this selector is in random order (for most cases).Iterator<Object>
iterator()
ListIterator<Object>
listIterator()
ListIterator<Object>
listIterator(int index)
void
phaseEnded(AbstractPhaseScope phaseScope)
void
phaseStarted(AbstractPhaseScope phaseScope)
-
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, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
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, solvingStarted
-
-
-
-
Field Detail
-
childEntitySelector
protected final EntitySelector childEntitySelector
-
originEntitySelector
protected final EntitySelector originEntitySelector
-
nearbyDistanceMeter
protected final NearbyDistanceMeter nearbyDistanceMeter
-
nearbyRandom
protected final NearbyRandom nearbyRandom
-
randomSelection
protected final boolean randomSelection
-
discardNearbyIndexZero
protected final boolean discardNearbyIndexZero
- See Also:
- Constant Field Values
-
nearbyDistanceMatrix
protected NearbyDistanceMatrix nearbyDistanceMatrix
-
-
Constructor Detail
-
NearEntityNearbyEntitySelector
public NearEntityNearbyEntitySelector(EntitySelector childEntitySelector, EntitySelector originEntitySelector, NearbyDistanceMeter nearbyDistanceMeter, NearbyRandom nearbyRandom, boolean randomSelection)
-
-
Method Detail
-
phaseStarted
public void phaseStarted(AbstractPhaseScope phaseScope)
- Specified by:
phaseStarted
in interfacePhaseLifecycleListener
- Overrides:
phaseStarted
in classAbstractSelector
-
phaseEnded
public void phaseEnded(AbstractPhaseScope phaseScope)
- Specified by:
phaseEnded
in interfacePhaseLifecycleListener
- Overrides:
phaseEnded
in classAbstractSelector
-
getEntityDescriptor
public EntityDescriptor getEntityDescriptor()
- Returns:
- never null
-
isCountable
public boolean isCountable()
Description copied from interface:Selector
If false, thenSelector.isNeverEnding()
is true.- Returns:
- true if all the
ValueRange
s 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 ifSelector.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 theIterator
created byIterable.iterator()
never returns false (except when it's empty).
-
getSize
public long getSize()
Description copied from interface:IterableSelector
A random JITSelector
withSelector.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 inSelectionProbabilityWeightFactory
.- Returns:
- the approximate number of elements generated by this
Selector
, always>= 0
-
listIterator
public ListIterator<Object> listIterator()
- Returns:
- never null, see
List.listIterator()
. - See Also:
List.listIterator()
-
listIterator
public ListIterator<Object> listIterator(int index)
- Parameters:
index
- lower than the size of thisListIterable
, seeList.listIterator(int)
.- Returns:
- never null, see
List.listIterator(int)
. - See Also:
List.listIterator()
-
endingIterator
public Iterator<Object> endingIterator()
Description copied from interface:EntitySelector
IfSelector.isNeverEnding()
is true, thenIterable.iterator()
will never end. This returns an endingIterator
, that tries to matchIterable.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 thisEntitySelector
entirely.- Returns:
- never null
- See Also:
Iterable.iterator()
-
-