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

Class MimicRecordingSubListSelector<Solution_>

java.lang.Object

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

org.optaplanner.core.impl.heuristic.selector.list.mimic.MimicRecordingSubListSelector<Solution_>

All Implemented Interfaces:

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

public class MimicRecordingSubListSelector<Solution_>
extends AbstractSelector<Solution_>
implements SubListMimicRecorder<Solution_>, SubListSelector<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected final SubListSelector<Solution_>	childSubListSelector
protected final List<MimicReplayingSubListSelector<Solution_>>	replayingSubListSelectorList

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
MimicRecordingSubListSelector(SubListSelector<Solution_> childSubListSelector)

Method Summary

Modifier and Type	Method	Description
void	addMimicReplayingSubListSelector(MimicReplayingSubListSelector<Solution_> replayingSubListSelector)
Iterator<Object>	endingValueIterator()
boolean	equals(Object other)
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()
int	hashCode()
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<SubList>	iterator()
String	toString()

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

getCacheType, phaseEnded, phaseStarted, 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 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

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

solvingEnded, solvingError, solvingStarted

Field Details

childSubListSelector

protected final SubListSelector<Solution_> childSubListSelector

replayingSubListSelectorList

protected final List<MimicReplayingSubListSelector<Solution_>> replayingSubListSelectorList

Constructor Details

MimicRecordingSubListSelector

public MimicRecordingSubListSelector(SubListSelector<Solution_> childSubListSelector)

Method Details

addMimicReplayingSubListSelector

public void addMimicReplayingSubListSelector(MimicReplayingSubListSelector<Solution_> replayingSubListSelector)

Specified by:

addMimicReplayingSubListSelector in interface SubListMimicRecorder<Solution_>

getVariableDescriptor

public ListVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface SubListMimicRecorder<Solution_>

Specified by:

getVariableDescriptor in interface SubListSelector<Solution_>

isCountable

public boolean isCountable()

Description copied from interface: Selector

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

Specified by:

isCountable in interface Selector<Solution_>

Specified by:

isCountable in interface SubListMimicRecorder<Solution_>

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

Specified by:

isNeverEnding in interface Selector<Solution_>

Specified by:

isNeverEnding in interface SubListMimicRecorder<Solution_>

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

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>

Specified by:

getSize in interface SubListMimicRecorder<Solution_>

Returns:

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

iterator

public Iterator<SubList> iterator()

Specified by:

iterator in interface Iterable<Solution_>

endingValueIterator

public Iterator<Object> endingValueIterator()

Specified by:

endingValueIterator in interface SubListMimicRecorder<Solution_>

Specified by:

endingValueIterator in interface SubListSelector<Solution_>

getValueCount

public long getValueCount()

Specified by:

getValueCount in interface SubListMimicRecorder<Solution_>

Specified by:

getValueCount in interface SubListSelector<Solution_>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object