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

Class MoveIteratorFactoryToMoveSelectorBridge<Solution_>

java.lang.Object

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

org.optaplanner.core.impl.heuristic.selector.move.AbstractMoveSelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.move.factory.MoveIteratorFactoryToMoveSelectorBridge<Solution_>

All Implemented Interfaces:

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

public class MoveIteratorFactoryToMoveSelectorBridge<Solution_>
extends AbstractMoveSelector<Solution_>

Bridges a MoveIteratorFactory to a MoveSelector.

Field Summary

Fields

Modifier and Type	Field	Description
protected final MoveIteratorFactory<Solution_,?>	moveIteratorFactory
protected final boolean	randomSelection
protected ScoreDirector<Solution_>	scoreDirector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
MoveIteratorFactoryToMoveSelectorBridge(MoveIteratorFactory<Solution_,?> 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<Solution_>>	iterator()
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> 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

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

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, solvingError, solvingStarted

Field Details

moveIteratorFactory

protected final MoveIteratorFactory<Solution_,?> moveIteratorFactory

randomSelection

protected final boolean randomSelection

scoreDirector

protected ScoreDirector<Solution_> scoreDirector

Constructor Details

MoveIteratorFactoryToMoveSelectorBridge

public MoveIteratorFactoryToMoveSelectorBridge(MoveIteratorFactory<Solution_,?> moveIteratorFactory,
 boolean randomSelection)

Method Details

supportsPhaseAndSolverCaching

public boolean supportsPhaseAndSolverCaching()

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

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

toString

public String toString()

Overrides:

toString in class Object