Package org.optaplanner.core.impl.heuristic.selector.entity.pillar

Class DefaultPillarSelector<Solution_>

java.lang.Object

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

org.optaplanner.core.impl.heuristic.selector.entity.pillar.DefaultPillarSelector<Solution_>

All Implemented Interfaces:

Iterable<List<Object>>, EventListener, ListIterable<List<Object>>, SelectionCacheLifecycleListener<Solution_>, PillarSelector<Solution_>, IterableSelector<Solution_,List<Object>>, ListIterableSelector<Solution_,List<Object>>, Selector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>

public class DefaultPillarSelector<Solution_>
extends AbstractSelector<Solution_>
implements PillarSelector<Solution_>, SelectionCacheLifecycleListener<Solution_>

See Also:

PillarSelector

Field Summary

Fields

Modifier and Type	Field	Description
protected static SelectionCacheType	CACHE_TYPE
protected List<List<Object>>	cachedBasePillarList
protected EntitySelector<Solution_>	entitySelector
protected boolean	randomSelection
protected SubPillarConfigPolicy	subpillarConfigPolicy
protected List<GenuineVariableDescriptor<Solution_>>	variableDescriptors

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
DefaultPillarSelector(EntitySelector<Solution_> entitySelector, List<GenuineVariableDescriptor<Solution_>> variableDescriptors, boolean randomSelection, SubPillarConfigPolicy subpillarConfigPolicy)

Method Summary

Modifier and Type	Method	Description
void	constructCache(SolverScope<Solution_> solverScope)
void	disposeCache(SolverScope<Solution_> solverScope)
SelectionCacheType	getCacheType()	Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.
EntityDescriptor<Solution_>	getEntityDescriptor()
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<List<Object>>	iterator()
ListIterator<List<Object>>	listIterator()
ListIterator<List<Object>>	listIterator(int index)
String	toString()

Methods inherited from class org.optaplanner.core.impl.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 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

phaseEnded, phaseStarted, stepEnded, stepStarted

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

solvingEnded, solvingStarted

Field Detail

CACHE_TYPE

protected static final SelectionCacheType CACHE_TYPE

entitySelector

protected final EntitySelector<Solution_> entitySelector

variableDescriptors

protected final List<GenuineVariableDescriptor<Solution_>> variableDescriptors

randomSelection

protected final boolean randomSelection

subpillarConfigPolicy

protected final SubPillarConfigPolicy subpillarConfigPolicy

cachedBasePillarList

protected List<List<Object>> cachedBasePillarList

Constructor Detail

DefaultPillarSelector

public DefaultPillarSelector(EntitySelector<Solution_> entitySelector,
                             List<GenuineVariableDescriptor<Solution_>> variableDescriptors,
                             boolean randomSelection,
                             SubPillarConfigPolicy subpillarConfigPolicy)

Method Detail

getEntityDescriptor

public EntityDescriptor<Solution_> getEntityDescriptor()

Specified by:

getEntityDescriptor in interface PillarSelector<Solution_>

Returns:

never null

getCacheType

public SelectionCacheType getCacheType()

Description copied from interface: Selector

Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.

Specified by:

getCacheType in interface Selector<Solution_>

Overrides:

getCacheType in class AbstractSelector<Solution_>

Returns:

never null

constructCache

public void constructCache(SolverScope<Solution_> solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener<Solution_>

disposeCache

public void disposeCache(SolverScope<Solution_> solverScope)

Specified by:

disposeCache in interface SelectionCacheLifecycleListener<Solution_>

isCountable

public boolean isCountable()

Description copied from interface: Selector

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

Specified by:

isCountable in interface Selector<Solution_>

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

Specified by:

isNeverEnding in interface Selector<Solution_>

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.

Specified by:

getSize in interface IterableSelector<Solution_,List<Object>>

Returns:

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

iterator

public Iterator<List<Object>> iterator()

Specified by:

iterator in interface Iterable<Solution_>

listIterator

public ListIterator<List<Object>> listIterator()

Specified by:

listIterator in interface ListIterable<Solution_>

Returns:

never null, see List.listIterator().

See Also:

List.listIterator()

listIterator

public ListIterator<List<Object>> listIterator(int index)

Specified by:

listIterator in interface ListIterable<Solution_>

Parameters:

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

Returns:

never null, see List.listIterator(int).

See Also:

List.listIterator()

toString

public String toString()

Overrides:

toString in class Object