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

Class SwapMoveSelector

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.generic.GenericMoveSelector

org.optaplanner.core.impl.heuristic.selector.move.generic.SwapMoveSelector

All Implemented Interfaces:

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

public class SwapMoveSelector
extends GenericMoveSelector

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	anyChained
protected List<SingletonInverseVariableSupply>	inverseVariableSupplyList
protected EntitySelector	leftEntitySelector
protected boolean	randomSelection
protected EntitySelector	rightEntitySelector
protected List<GenuineVariableDescriptor>	variableDescriptorList

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor and Description
SwapMoveSelector(EntitySelector leftEntitySelector, EntitySelector rightEntitySelector, List<GenuineVariableDescriptor> variableDescriptorList, boolean randomSelection)

Method Summary

Modifier and Type	Method and 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	solvingEnded(DefaultSolverScope solverScope)
void	solvingStarted(DefaultSolverScope solverScope)
boolean	supportsPhaseAndSolverCaching()
String	toString()

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

getCacheType, phaseEnded, phaseStarted, 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.heuristic.selector.Selector

getCacheType

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

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

leftEntitySelector

protected final EntitySelector leftEntitySelector

rightEntitySelector

protected final EntitySelector rightEntitySelector

variableDescriptorList

protected final List<GenuineVariableDescriptor> variableDescriptorList

randomSelection

protected final boolean randomSelection

anyChained

protected final boolean anyChained

inverseVariableSupplyList

protected List<SingletonInverseVariableSupply> inverseVariableSupplyList

Constructor Detail

SwapMoveSelector

public SwapMoveSelector(EntitySelector leftEntitySelector,
                        EntitySelector rightEntitySelector,
                        List<GenuineVariableDescriptor> variableDescriptorList,
                        boolean randomSelection)

Method Detail

supportsPhaseAndSolverCaching

public boolean supportsPhaseAndSolverCaching()

solvingStarted

public void solvingStarted(DefaultSolverScope solverScope)

Specified by:

solvingStarted in interface SolverLifecycleListener

Overrides:

solvingStarted in class AbstractSelector

solvingEnded

public void solvingEnded(DefaultSolverScope solverScope)

Specified by:

solvingEnded in interface SolverLifecycleListener

Overrides:

solvingEnded 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