Package ai.timefold.solver.core.impl.neighborhood

Class NeighborhoodsMoveSelector<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector<Solution_>

ai.timefold.solver.core.impl.heuristic.selector.move.AbstractMoveSelector<Solution_>

ai.timefold.solver.core.impl.neighborhood.NeighborhoodsMoveSelector<Solution_>

All Implemented Interfaces:

IterableSelector<Solution_,Move<Solution_>>, MoveSelector<Solution_>, Selector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>, Iterable<Move<Solution_>>, EventListener

public final class NeighborhoodsMoveSelector<Solution_>
extends AbstractMoveSelector<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.heuristic.selector.AbstractSelector

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
NeighborhoodsMoveSelector(NeighborhoodsBasedMoveRepository<Solution_> moveRepository)

Method Summary

Modifier and Type	Method	Description
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.
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<Solution_>>	iterator()
void	phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
void	solvingEnded(SolverScope<Solution_> solverScope)
void	solvingStarted(SolverScope<Solution_> solverScope)
void	stepEnded(AbstractStepScope<Solution_> stepScope)
void	stepStarted(AbstractStepScope<Solution_> stepScope)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface ai.timefold.solver.core.impl.heuristic.selector.IterableSelector

spliterator

Methods inherited from interface ai.timefold.solver.core.impl.heuristic.selector.move.MoveSelector

supportsPhaseAndSolverCaching

Methods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener

solvingError

Constructor Details

NeighborhoodsMoveSelector

public NeighborhoodsMoveSelector(NeighborhoodsBasedMoveRepository<Solution_> moveRepository)

Method Details

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

isCountable

public boolean isCountable()

Description copied from interface: Selector

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

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

Returns:

true if the Iterator.hasNext() of the Iterator created by Iterable.iterator() never returns false (except when it's empty).

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

solvingStarted

public void solvingStarted(SolverScope<Solution_> solverScope)

Specified by:

solvingStarted in interface SolverLifecycleListener<Solution_>

Overrides:

solvingStarted in class AbstractSelector<Solution_>

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseStarted in class AbstractSelector<Solution_>

stepStarted

public void stepStarted(AbstractStepScope<Solution_> stepScope)

Specified by:

stepStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

stepStarted in class AbstractSelector<Solution_>

stepEnded

public void stepEnded(AbstractStepScope<Solution_> stepScope)

Specified by:

stepEnded in interface PhaseLifecycleListener<Solution_>

Overrides:

stepEnded in class AbstractSelector<Solution_>

phaseEnded

public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseEnded in class AbstractSelector<Solution_>

solvingEnded

public void solvingEnded(SolverScope<Solution_> solverScope)

Specified by:

solvingEnded in interface SolverLifecycleListener<Solution_>

Overrides:

solvingEnded in class AbstractSelector<Solution_>

iterator

public Iterator<Move<Solution_>> iterator()