org.drools.planner.core.heuristic.selector.value.chained
Class DefaultSubChainSelector

java.lang.Object
  org.drools.planner.core.heuristic.selector.AbstractSelector
      org.drools.planner.core.heuristic.selector.value.chained.DefaultSubChainSelector

All Implemented Interfaces:

Iterable<SubChain>, EventListener, ListIterable<SubChain>, SelectionCacheLifecycleListener, Selector, SubChainSelector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class DefaultSubChainSelector
extends AbstractSelector
implements SubChainSelector, SelectionCacheLifecycleListener

This is the common SubChainSelector implementation.

Field Summary

protected List<SubChain>	anchorTrailingChainList
protected int	minimumSubChainSize
protected boolean	randomSelection
protected ValueSelector	valueSelector

Fields inherited from class org.drools.planner.core.heuristic.selector.AbstractSelector

logger, solverPhaseLifecycleSupport, workingRandom

Constructor Summary

DefaultSubChainSelector(ValueSelector valueSelector, boolean randomSelection, int minimumSubChainSize)

Method Summary

void	constructCache(DefaultSolverScope solverScope)
void	disposeCache(DefaultSolverScope solverScope)
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.
PlanningVariableDescriptor	getVariableDescriptor()
boolean	isContinuous() If true, then Selector.isNeverEnding() is also true.
boolean	isNeverEnding() Is true if Selector.isContinuous() is true or if this selector is in random order (for most cases).
Iterator<SubChain>	iterator()
ListIterator<SubChain>	listIterator() See List.listIterator()
ListIterator<SubChain>	listIterator(int index) See List.listIterator()
String	toString()

Methods inherited from class org.drools.planner.core.heuristic.selector.AbstractSelector

phaseEnded, phaseStarted, 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.drools.planner.core.phase.event.SolverPhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface org.drools.planner.core.solver.event.SolverLifecycleListener

solvingEnded, solvingStarted

Field Detail

valueSelector

protected final ValueSelector valueSelector

randomSelection

protected final boolean randomSelection

minimumSubChainSize

protected final int minimumSubChainSize

anchorTrailingChainList

protected List<SubChain> anchorTrailingChainList

Constructor Detail

DefaultSubChainSelector

public DefaultSubChainSelector(ValueSelector valueSelector,
                               boolean randomSelection,
                               int minimumSubChainSize)

Method Detail

getVariableDescriptor

public PlanningVariableDescriptor getVariableDescriptor()

Specified by:

getVariableDescriptor in interface SubChainSelector

Returns:

never null

constructCache

public void constructCache(DefaultSolverScope solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener

disposeCache

public void disposeCache(DefaultSolverScope solverScope)

Specified by:

disposeCache in interface SelectionCacheLifecycleListener

isContinuous

public boolean isContinuous()

Description copied from interface: Selector

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

Specified by:

isContinuous in interface Selector

Returns:

true if any of the value ranges are continuous (as in for example every double value between 1.2 and 1.4)

isNeverEnding

public boolean isNeverEnding()

Description copied from interface: Selector

Is true if Selector.isContinuous() is true 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

Returns:

true if the Iterator.hasNext() of the Iterator created by Iterable.iterator() never returns false.

getSize

public long getSize()

Description copied from interface: Selector

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 Selector

Returns:

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

iterator

public Iterator<SubChain> iterator()

Specified by:

iterator in interface Iterable<SubChain>

listIterator

public ListIterator<SubChain> listIterator()

Description copied from interface: ListIterable

See List.listIterator()

Specified by:

listIterator in interface ListIterable<SubChain>

Returns:

never null, see List.listIterator().

listIterator

public ListIterator<SubChain> listIterator(int index)

Description copied from interface: ListIterable

See List.listIterator()

Specified by:

listIterator in interface ListIterable<SubChain>

Parameters:

index - lower than the size of this ListIterable, see List.listIterator(int).

Returns:

never null, see List.listIterator(int).

toString

public String toString()

Overrides:

toString in class Object