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

Class FilteringMoveSelector

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.decorator.FilteringMoveSelector

All Implemented Interfaces:

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

public class FilteringMoveSelector
extends AbstractMoveSelector

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bailOutEnabled
protected MoveSelector	childMoveSelector
protected List<SelectionFilter>	filterList
protected ScoreDirector	scoreDirector

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor and Description
FilteringMoveSelector(MoveSelector childMoveSelector, List<SelectionFilter> filterList)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	determineBailOutSize()
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)
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 org.optaplanner.core.impl.heuristic.selector.Selector

getCacheType

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

stepEnded, stepStarted

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

solvingEnded, solvingStarted

Field Detail

childMoveSelector

protected final MoveSelector childMoveSelector

filterList

protected final List<SelectionFilter> filterList

bailOutEnabled

protected final boolean bailOutEnabled

scoreDirector

protected ScoreDirector scoreDirector

Constructor Detail

FilteringMoveSelector

public FilteringMoveSelector(MoveSelector childMoveSelector,
                     List<SelectionFilter> filterList)

Method Detail

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

determineBailOutSize

protected long determineBailOutSize()

toString

public String toString()

Overrides:

toString in class Object