Package ai.timefold.solver.core.config.heuristic.selector.move

Class MoveSelectorConfig<Config_ extends MoveSelectorConfig<Config_>>

java.lang.Object

ai.timefold.solver.core.config.AbstractConfig<Config_>

ai.timefold.solver.core.config.heuristic.selector.SelectorConfig<Config_>

ai.timefold.solver.core.config.heuristic.selector.move.MoveSelectorConfig<Config_>

Direct Known Subclasses:

AbstractPillarMoveSelectorConfig, CartesianProductMoveSelectorConfig, ChangeMoveSelectorConfig, KOptListMoveSelectorConfig, KOptMoveSelectorConfig, ListChangeMoveSelectorConfig, ListRuinRecreateMoveSelectorConfig, ListSwapMoveSelectorConfig, MoveIteratorFactoryConfig, MoveListFactoryConfig, RuinRecreateMoveSelectorConfig, SubChainChangeMoveSelectorConfig, SubChainSwapMoveSelectorConfig, SubListChangeMoveSelectorConfig, SubListSwapMoveSelectorConfig, SwapMoveSelectorConfig, TailChainSwapMoveSelectorConfig, UnionMoveSelectorConfig

public abstract class MoveSelectorConfig<Config_ extends MoveSelectorConfig<Config_>>
extends SelectorConfig<Config_>

General superclass for ChangeMoveSelectorConfig, etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected SelectionCacheType	cacheType
protected Class<? extends SelectionFilter>	filterClass
protected Class<? extends SelectionProbabilityWeightFactory>	probabilityWeightFactoryClass
protected Long	selectedCountLimit
protected SelectionOrder	selectionOrder
protected Class<? extends SelectionSorter>	sorterClass
protected Class<? extends Comparator>	sorterComparatorClass
protected SelectionSorterOrder	sorterOrder
protected Class<? extends SelectionSorterWeightFactory>	sorterWeightFactoryClass

Constructor Summary

Constructors

Constructor	Description
MoveSelectorConfig()

Method Summary

Modifier and Type	Method	Description
void	extractLeafMoveSelectorConfigsIntoList(@NonNull List<@NonNull MoveSelectorConfig> leafMoveSelectorConfigList)	Gather a list of all descendant MoveSelectorConfigs except for UnionMoveSelectorConfig and CartesianProductMoveSelectorConfig.
@Nullable SelectionCacheType	getCacheType()
@Nullable Class<? extends SelectionFilter>	getFilterClass()
@Nullable Double	getFixedProbabilityWeight()
@Nullable Class<? extends SelectionProbabilityWeightFactory>	getProbabilityWeightFactoryClass()
@Nullable Long	getSelectedCountLimit()
@Nullable SelectionOrder	getSelectionOrder()
@Nullable Class<? extends SelectionSorter>	getSorterClass()
@Nullable Class<? extends Comparator>	getSorterComparatorClass()
@Nullable SelectionSorterOrder	getSorterOrder()
@Nullable Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()
@NonNull Config_	inherit(@NonNull Config_ inheritedConfig)	Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).
void	inheritFolded(@NonNull MoveSelectorConfig<?> foldedConfig)	Does not inherit subclass properties because this class and foldedConfig can be of a different type.
void	setCacheType(@Nullable SelectionCacheType cacheType)
void	setFilterClass(@Nullable Class<? extends SelectionFilter> filterClass)
void	setFixedProbabilityWeight(@Nullable Double fixedProbabilityWeight)
void	setProbabilityWeightFactoryClass(@Nullable Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)
void	setSelectedCountLimit(@Nullable Long selectedCountLimit)
void	setSelectionOrder(@Nullable SelectionOrder selectionOrder)
void	setSorterClass(@Nullable Class<? extends SelectionSorter> sorterClass)
void	setSorterComparatorClass(@Nullable Class<? extends Comparator> sorterComparatorClass)
void	setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)
protected void	visitCommonReferencedClasses(@NonNull Consumer<Class<?>> classVisitor)
@NonNull Config_	withCacheType(@NonNull SelectionCacheType cacheType)
@NonNull Config_	withFilterClass(@NonNull Class<? extends SelectionFilter> filterClass)
@NonNull Config_	withFixedProbabilityWeight(@NonNull Double fixedProbabilityWeight)
@NonNull Config_	withProbabilityWeightFactoryClass(@NonNull Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)
@NonNull Config_	withSelectedCountLimit(@NonNull Long selectedCountLimit)
@NonNull Config_	withSelectionOrder(@NonNull SelectionOrder selectionOrder)
@NonNull Config_	withSorterClass(@NonNull Class<? extends SelectionSorter> sorterClass)
@NonNull Config_	withSorterComparatorClass(@NonNull Class<? extends Comparator> sorterComparatorClass)
@NonNull Config_	withSorterOrder(@NonNull SelectionSorterOrder sorterOrder)
@NonNull Config_	withSorterWeightFactoryClass(@NonNull Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

Methods inherited from class ai.timefold.solver.core.config.heuristic.selector.SelectorConfig

hasNearbySelectionConfig

Methods inherited from class ai.timefold.solver.core.config.AbstractConfig

copyConfig, toString, visitReferencedClasses

Methods inherited from class java.lang.Object

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

Field Details

cacheType

protected SelectionCacheType cacheType

selectionOrder

protected SelectionOrder selectionOrder

filterClass

protected Class<? extends SelectionFilter> filterClass

sorterComparatorClass

protected Class<? extends Comparator> sorterComparatorClass

sorterWeightFactoryClass

protected Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass

sorterOrder

protected SelectionSorterOrder sorterOrder

sorterClass

protected Class<? extends SelectionSorter> sorterClass

probabilityWeightFactoryClass

protected Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass

selectedCountLimit

protected Long selectedCountLimit

Constructor Details

MoveSelectorConfig

public MoveSelectorConfig()

Method Details

getCacheType

public @Nullable SelectionCacheType getCacheType()

setCacheType

public void setCacheType(@Nullable SelectionCacheType cacheType)

getSelectionOrder

public @Nullable SelectionOrder getSelectionOrder()

setSelectionOrder

public void setSelectionOrder(@Nullable SelectionOrder selectionOrder)

getFilterClass

public @Nullable Class<? extends SelectionFilter> getFilterClass()

setFilterClass

public void setFilterClass(@Nullable Class<? extends SelectionFilter> filterClass)

getSorterComparatorClass

public @Nullable Class<? extends Comparator> getSorterComparatorClass()

setSorterComparatorClass

public void setSorterComparatorClass(@Nullable Class<? extends Comparator> sorterComparatorClass)

getSorterWeightFactoryClass

public @Nullable Class<? extends SelectionSorterWeightFactory> getSorterWeightFactoryClass()

setSorterWeightFactoryClass

public void setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

getSorterOrder

public @Nullable SelectionSorterOrder getSorterOrder()

setSorterOrder

public void setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)

getSorterClass

public @Nullable Class<? extends SelectionSorter> getSorterClass()

setSorterClass

public void setSorterClass(@Nullable Class<? extends SelectionSorter> sorterClass)

getProbabilityWeightFactoryClass

public @Nullable Class<? extends SelectionProbabilityWeightFactory> getProbabilityWeightFactoryClass()

setProbabilityWeightFactoryClass

public void setProbabilityWeightFactoryClass(@Nullable Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)

getSelectedCountLimit

public @Nullable Long getSelectedCountLimit()

setSelectedCountLimit

public void setSelectedCountLimit(@Nullable Long selectedCountLimit)

getFixedProbabilityWeight

public @Nullable Double getFixedProbabilityWeight()

setFixedProbabilityWeight

public void setFixedProbabilityWeight(@Nullable Double fixedProbabilityWeight)

withCacheType

public @NonNull Config_ withCacheType(@NonNull SelectionCacheType cacheType)

withSelectionOrder

public @NonNull Config_ withSelectionOrder(@NonNull SelectionOrder selectionOrder)

withFilterClass

public @NonNull Config_ withFilterClass(@NonNull Class<? extends SelectionFilter> filterClass)

withSorterComparatorClass

public @NonNull Config_ withSorterComparatorClass(@NonNull Class<? extends Comparator> sorterComparatorClass)

withSorterWeightFactoryClass

public @NonNull Config_ withSorterWeightFactoryClass(@NonNull Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

withSorterOrder

public @NonNull Config_ withSorterOrder(@NonNull SelectionSorterOrder sorterOrder)

withSorterClass

public @NonNull Config_ withSorterClass(@NonNull Class<? extends SelectionSorter> sorterClass)

withProbabilityWeightFactoryClass

public @NonNull Config_ withProbabilityWeightFactoryClass(@NonNull Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)

withSelectedCountLimit

public @NonNull Config_ withSelectedCountLimit(@NonNull Long selectedCountLimit)

withFixedProbabilityWeight

public @NonNull Config_ withFixedProbabilityWeight(@NonNull Double fixedProbabilityWeight)

extractLeafMoveSelectorConfigsIntoList

public void extractLeafMoveSelectorConfigsIntoList(@NonNull List<@NonNull MoveSelectorConfig> leafMoveSelectorConfigList)

Gather a list of all descendant MoveSelectorConfigs except for UnionMoveSelectorConfig and CartesianProductMoveSelectorConfig.

inherit

public @NonNull Config_ inherit(@NonNull Config_ inheritedConfig)

Description copied from class: AbstractConfig

Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).

After the inheritance, if a property on this AbstractConfig composition is replaced, it should not affect the inherited composition instance.

Specified by:

inherit in class AbstractConfig<Config_ extends MoveSelectorConfig<Config_>>

Returns:

this

inheritFolded

public void inheritFolded(@NonNull MoveSelectorConfig<?> foldedConfig)

Does not inherit subclass properties because this class and foldedConfig can be of a different type.

visitCommonReferencedClasses

protected void visitCommonReferencedClasses(@NonNull Consumer<Class<?>> classVisitor)