OptaPlanner core 6.0.0.CR2

org.optaplanner.core.impl.heuristic.selector.move.composite
Class CartesianProductMoveSelector

java.lang.Object
  extended by org.optaplanner.core.impl.heuristic.selector.AbstractSelector
      extended by org.optaplanner.core.impl.heuristic.selector.move.AbstractMoveSelector
          extended by org.optaplanner.core.impl.heuristic.selector.move.composite.CompositeMoveSelector
              extended by org.optaplanner.core.impl.heuristic.selector.move.composite.CartesianProductMoveSelector
All Implemented Interfaces:
Iterable<Move>, EventListener, IterableSelector<Move>, MoveSelector, Selector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class CartesianProductMoveSelector
extends CompositeMoveSelector

A CompositeMoveSelector that cartesian products 2 or more MoveSelectors.

For example: a cartesian product of {A, B, C} and {X, Y} will result in {AX, AY, BX, BY, CX, CY}.

Warning: there is no duplicated Move check, so union of {A, B} and {B} will result in {AB, BB}.

See Also:
CompositeMoveSelector

Nested Class Summary
 class CartesianProductMoveSelector.OriginalCartesianProductMoveIterator
           
 class CartesianProductMoveSelector.RandomCartesianProductMoveIterator
           
 
Field Summary
 
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.move.composite.CompositeMoveSelector
childMoveSelectorList, randomSelection
 
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, solverPhaseLifecycleSupport, workingRandom
 
Constructor Summary
CartesianProductMoveSelector(List<MoveSelector> childMoveSelectorList, boolean ignoreEmptyChildIterators, boolean randomSelection)
           
 
Method Summary
 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 isNeverEnding()
          Is true if Selector.isContinuous() is true or if this selector is in random order (for most cases).
 Iterator<Move> iterator()
           
 String toString()
           
 
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.move.composite.CompositeMoveSelector
isContinuous
 
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
getCacheType, 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.heuristic.selector.Selector
getCacheType
 
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
 

Constructor Detail

CartesianProductMoveSelector

public CartesianProductMoveSelector(List<MoveSelector> childMoveSelectorList,
                                    boolean ignoreEmptyChildIterators,
                                    boolean randomSelection)
Method Detail

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

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

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

toString

public String toString()
Overrides:
toString in class CompositeMoveSelector

OptaPlanner core 6.0.0.CR2

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