org.drools.planner.core.heuristic.selector.entity.decorator
Class ProbabilityEntitySelector

java.lang.Object
  extended by org.drools.planner.core.heuristic.selector.AbstractSelector
      extended by org.drools.planner.core.heuristic.selector.entity.AbstractEntitySelector
          extended by org.drools.planner.core.heuristic.selector.entity.decorator.ProbabilityEntitySelector
All Implemented Interfaces:
Iterable<Object>, EventListener, ListIterable<Object>, SelectionCacheLifecycleListener, EntitySelector, Selector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class ProbabilityEntitySelector
extends AbstractEntitySelector
implements SelectionCacheLifecycleListener


Field Summary
protected  NavigableMap<Double,Object> cachedEntityMap
           
protected  SelectionCacheType cacheType
           
protected  EntitySelector childEntitySelector
           
protected  SelectionProbabilityWeightFactory entityProbabilityWeightFactory
           
protected  double probabilityWeightTotal
           
 
Fields inherited from class org.drools.planner.core.heuristic.selector.AbstractSelector
logger, solverPhaseLifecycleSupport, workingRandom
 
Constructor Summary
ProbabilityEntitySelector(EntitySelector childEntitySelector, SelectionCacheType cacheType, SelectionProbabilityWeightFactory entityProbabilityWeightFactory)
           
 
Method Summary
 void constructCache(DefaultSolverScope solverScope)
           
 void disposeCache(DefaultSolverScope solverScope)
           
 PlanningEntityDescriptor 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 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()
           
 ListIterator<Object> listIterator()
          See List.listIterator()
 ListIterator<Object> 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

childEntitySelector

protected final EntitySelector childEntitySelector

cacheType

protected final SelectionCacheType cacheType

entityProbabilityWeightFactory

protected final SelectionProbabilityWeightFactory entityProbabilityWeightFactory

cachedEntityMap

protected NavigableMap<Double,Object> cachedEntityMap

probabilityWeightTotal

protected double probabilityWeightTotal
Constructor Detail

ProbabilityEntitySelector

public ProbabilityEntitySelector(EntitySelector childEntitySelector,
                                 SelectionCacheType cacheType,
                                 SelectionProbabilityWeightFactory entityProbabilityWeightFactory)
Method Detail

constructCache

public void constructCache(DefaultSolverScope solverScope)
Specified by:
constructCache in interface SelectionCacheLifecycleListener

disposeCache

public void disposeCache(DefaultSolverScope solverScope)
Specified by:
disposeCache in interface SelectionCacheLifecycleListener

getEntityDescriptor

public PlanningEntityDescriptor getEntityDescriptor()
Specified by:
getEntityDescriptor in interface EntitySelector
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()
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<Object> iterator()
Specified by:
iterator in interface Iterable<Object>

listIterator

public ListIterator<Object> listIterator()
Description copied from interface: ListIterable
See List.listIterator()

Specified by:
listIterator in interface ListIterable<Object>
Returns:
never null, see List.listIterator().

listIterator

public ListIterator<Object> listIterator(int index)
Description copied from interface: ListIterable
See List.listIterator()

Specified by:
listIterator in interface ListIterable<Object>
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


Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.