OptaPlanner core 6.0.1.Final

org.optaplanner.core.impl.heuristic.selector.value.decorator
Class ProbabilityValueSelector

java.lang.Object
  extended by org.optaplanner.core.impl.heuristic.selector.AbstractSelector
      extended by org.optaplanner.core.impl.heuristic.selector.value.AbstractValueSelector
          extended by org.optaplanner.core.impl.heuristic.selector.value.decorator.ProbabilityValueSelector
All Implemented Interfaces:
Iterable<Object>, EventListener, SelectionCacheLifecycleListener, IterableSelector<Object>, Selector, EntityIndependentValueSelector, ValueSelector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class ProbabilityValueSelector
extends AbstractValueSelector
implements EntityIndependentValueSelector, SelectionCacheLifecycleListener


Field Summary
protected  NavigableMap<Double,Object> cachedEntityMap
           
protected  SelectionCacheType cacheType
           
protected  EntityIndependentValueSelector childValueSelector
           
protected  SelectionProbabilityWeightFactory probabilityWeightFactory
           
protected  double probabilityWeightTotal
           
 
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, solverPhaseLifecycleSupport, workingRandom
 
Constructor Summary
ProbabilityValueSelector(EntityIndependentValueSelector childValueSelector, SelectionCacheType cacheType, SelectionProbabilityWeightFactory probabilityWeightFactory)
           
 
Method Summary
 void constructCache(DefaultSolverScope solverScope)
           
 void disposeCache(DefaultSolverScope solverScope)
           
 SelectionCacheType getCacheType()
          Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.
 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.
 long getSize(Object entity)
          Similar to IterableSelector.getSize(), but requires an entity.
 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<Object> iterator()
           
 Iterator<Object> iterator(Object entity)
          Similar to Iterable.iterator(), but requires an entity.
 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 org.optaplanner.core.impl.phase.event.SolverPhaseLifecycleListener
phaseEnded, phaseStarted, stepEnded, stepStarted
 
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
 

Field Detail

childValueSelector

protected final EntityIndependentValueSelector childValueSelector

cacheType

protected final SelectionCacheType cacheType

probabilityWeightFactory

protected final SelectionProbabilityWeightFactory probabilityWeightFactory

cachedEntityMap

protected NavigableMap<Double,Object> cachedEntityMap

probabilityWeightTotal

protected double probabilityWeightTotal
Constructor Detail

ProbabilityValueSelector

public ProbabilityValueSelector(EntityIndependentValueSelector childValueSelector,
                                SelectionCacheType cacheType,
                                SelectionProbabilityWeightFactory probabilityWeightFactory)
Method Detail

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
Overrides:
getCacheType in class AbstractSelector
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

getVariableDescriptor

public PlanningVariableDescriptor getVariableDescriptor()
Specified by:
getVariableDescriptor in interface ValueSelector
Returns:
never null

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(Object entity)
Description copied from interface: ValueSelector
Similar to IterableSelector.getSize(), but requires an entity.

Specified by:
getSize in interface ValueSelector
Parameters:
entity - never null
Returns:
the approximate number of elements generated by this Selector, always >= 0

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<Object>
Returns:
the approximate number of elements generated by this Selector, always >= 0

iterator

public Iterator<Object> iterator(Object entity)
Description copied from interface: ValueSelector
Similar to Iterable.iterator(), but requires an entity.

Specified by:
iterator in interface ValueSelector
Parameters:
entity - never null
Returns:
never null

iterator

public Iterator<Object> iterator()
Specified by:
iterator in interface Iterable<Object>

toString

public String toString()
Overrides:
toString in class Object

OptaPlanner core 6.0.1.Final

Copyright © 2006-2013 JBoss by Red Hat. All Rights Reserved.