Package org.optaplanner.core.impl.heuristic.selector.move.factory

Class MoveIteratorFactoryToMoveSelectorBridge

java.lang.Object

org.optaplanner.core.impl.heuristic.selector.AbstractSelector

org.optaplanner.core.impl.heuristic.selector.move.AbstractMoveSelector

org.optaplanner.core.impl.heuristic.selector.move.factory.MoveIteratorFactoryToMoveSelectorBridge

All Implemented Interfaces:

Iterable<Move>, EventListener, IterableSelector<Move>, MoveSelector, Selector, PhaseLifecycleListener, SolverLifecycleListener

public class MoveIteratorFactoryToMoveSelectorBridge
extends AbstractMoveSelector

Bridges a MoveIteratorFactory to a MoveSelector.

Field Summary

Fields

Modifier and Type	Field	Description
protected MoveIteratorFactory	moveIteratorFactory
protected boolean	randomSelection
protected ScoreDirector	scoreDirector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
MoveIteratorFactoryToMoveSelectorBridge(MoveIteratorFactory moveIteratorFactory, boolean randomSelection)

Method Summary

Modifier and Type	Method	Description
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.
boolean	isNeverEnding()	Is true if Selector.isCountable() is false or if this selector is in random order (for most cases).
Iterator<Move>	iterator()
void	phaseEnded(AbstractPhaseScope phaseScope)
void	phaseStarted(AbstractPhaseScope phaseScope)
boolean	supportsPhaseAndSolverCaching()
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 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

moveIteratorFactory

protected final MoveIteratorFactory moveIteratorFactory

randomSelection

protected final boolean randomSelection

scoreDirector

protected ScoreDirector scoreDirector

Constructor Detail

MoveIteratorFactoryToMoveSelectorBridge

public MoveIteratorFactoryToMoveSelectorBridge(MoveIteratorFactory moveIteratorFactory,
                                               boolean randomSelection)

Method Detail

supportsPhaseAndSolverCaching

public boolean supportsPhaseAndSolverCaching()

phaseStarted

public void phaseStarted(AbstractPhaseScope phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener

Overrides:

phaseStarted in class AbstractSelector

phaseEnded

public void phaseEnded(AbstractPhaseScope phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener

Overrides:

phaseEnded in class AbstractSelector

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

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.

Returns:

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

iterator

public Iterator<Move> iterator()

toString

public String toString()

Overrides:

toString in class Object