Package org.optaplanner.core.impl.heuristic.selector.move.generic.chained

## Class SubChainSwapMoveSelector

- java.lang.Object
- - org.optaplanner.core.impl.heuristic.selector.AbstractSelector
  - - org.optaplanner.core.impl.heuristic.selector.move.AbstractMoveSelector
    - - org.optaplanner.core.impl.heuristic.selector.move.generic.GenericMoveSelector
      - - org.optaplanner.core.impl.heuristic.selector.move.generic.chained.SubChainSwapMoveSelector

- All Implemented Interfaces:
    `Iterable<Move>`, `EventListener`, `IterableSelector<Move>`, `MoveSelector`, `Selector`, `PhaseLifecycleListener`, `SolverLifecycleListener`

      public class SubChainSwapMoveSelector
      extends GenericMoveSelector

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected SingletonInverseVariableSupply` | `inverseVariableSupply` |
    `protected SubChainSelector` | `leftSubChainSelector` |
    `protected boolean` | `randomSelection` |
    `protected SubChainSelector` | `rightSubChainSelector` |
    `protected boolean` | `selectReversingMoveToo` |
    `protected GenuineVariableDescriptor` | `variableDescriptor` |

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

      `logger, phaseLifecycleSupport, workingRandom`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `SubChainSwapMoveSelector​(SubChainSelector leftSubChainSelector, SubChainSelector rightSubChainSelector, boolean randomSelection, boolean selectReversingMoveToo)` |

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `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<Move>` | `iterator()` |
    `void` | `solvingEnded​(DefaultSolverScope solverScope)` |
    `void` | `solvingStarted​(DefaultSolverScope solverScope)` |
    `String` | `toString()` |

    - ### Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

      `getCacheType, phaseEnded, phaseStarted, 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, spliterator`

    - ### Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.move.MoveSelector

      `supportsPhaseAndSolverCaching`

    - ### Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener

      `phaseEnded, phaseStarted, stepEnded, stepStarted`

    - ### Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.Selector

      `getCacheType`

- - ### Field Detail

    - #### leftSubChainSelector

          protected final SubChainSelector leftSubChainSelector

    - #### rightSubChainSelector

          protected final SubChainSelector rightSubChainSelector

    - #### variableDescriptor

          protected final GenuineVariableDescriptor variableDescriptor

    - #### randomSelection

          protected final boolean randomSelection

    - #### selectReversingMoveToo

          protected final boolean selectReversingMoveToo

    - #### inverseVariableSupply

          protected SingletonInverseVariableSupply inverseVariableSupply

  - ### Constructor Detail

    - #### SubChainSwapMoveSelector

          public SubChainSwapMoveSelector​(SubChainSelector leftSubChainSelector,
                                          SubChainSelector rightSubChainSelector,
                                          boolean randomSelection,
                                          boolean selectReversingMoveToo)

  - ### Method Detail

    - #### solvingStarted

          public void solvingStarted​(DefaultSolverScope solverScope)

      Specified by:
        `solvingStarted` in interface `SolverLifecycleListener`
      Overrides:
        `solvingStarted` in class `AbstractSelector`

    - #### solvingEnded

          public void solvingEnded​(DefaultSolverScope solverScope)

      Specified by:
        `solvingEnded` in interface `SolverLifecycleListener`
      Overrides:
        `solvingEnded` in class `AbstractSelector`

    - #### isCountable

          public boolean isCountable()

      Description copied from interface: `Selector`
      If false, then `Selector.isNeverEnding()` is true.
      Returns:
        true if all the `ValueRange`s 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).
      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`.
      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 `Object`