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, ListMultistageMoveSelectorConfig, ListRuinRecreateMoveSelectorConfig, ListSwapMoveSelectorConfig, MoveIteratorFactoryConfig, MoveListFactoryConfig, MultistageMoveSelectorConfig, RuinRecreateMoveSelectorConfig, SubChainChangeMoveSelectorConfig, SubChainSwapMoveSelectorConfig, SubListChangeMoveSelectorConfig, SubListSwapMoveSelectorConfig, SwapMoveSelectorConfig, TailChainSwapMoveSelectorConfig, UnionMoveSelectorConfig

@NullMarked
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 @Nullable SelectionCacheType	cacheType
protected @Nullable Class<? extends Comparator>	comparatorClass
protected @Nullable Class<? extends ComparatorFactory>	comparatorFactoryClass
protected @Nullable Class<? extends SelectionFilter>	filterClass
protected @Nullable Class<? extends SelectionProbabilityWeightFactory>	probabilityWeightFactoryClass
protected @Nullable Long	selectedCountLimit
protected @Nullable SelectionOrder	selectionOrder
protected @Nullable Class<? extends SelectionSorter>	sorterClass
protected @Nullable Class<? extends Comparator>	sorterComparatorClass	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of comparatorClass.
protected @Nullable SelectionSorterOrder	sorterOrder
protected @Nullable Class<? extends SelectionSorterWeightFactory>	sorterWeightFactoryClass	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of comparatorFactoryClass.

Constructor Summary

Constructors

Constructor	Description
MoveSelectorConfig()

Method Summary

Modifier and Type	Method	Description
void	extractLeafMoveSelectorConfigsIntoList(List<MoveSelectorConfig> leafMoveSelectorConfigList)	Gather a list of all descendant MoveSelectorConfigs except for UnionMoveSelectorConfig and CartesianProductMoveSelectorConfig.
@Nullable SelectionCacheType	getCacheType()
@Nullable Class<? extends Comparator>	getComparatorClass()
@Nullable Class<? extends ComparatorFactory>	getComparatorFactoryClass()
@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()	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of getComparatorClass()
@Nullable SelectionSorterOrder	getSorterOrder()
@Nullable Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of getComparatorFactoryClass()
Config_	inherit(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(MoveSelectorConfig<?> foldedConfig)	Does not inherit subclass properties because this class and foldedConfig can be of a different type.
void	setCacheType(@Nullable SelectionCacheType cacheType)
void	setComparatorClass(@Nullable Class<? extends Comparator> comparatorClass)
void	setComparatorFactoryClass(@Nullable Class<? extends ComparatorFactory> comparatorFactoryClass)
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)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of setComparatorClass(Class)
void	setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of setComparatorFactoryClass(Class)
protected void	visitCommonReferencedClasses(Consumer<Class<?>> classVisitor)
Config_	withCacheType(SelectionCacheType cacheType)
Config_	withComparatorClass(Class<? extends Comparator> comparatorClass)
Config_	withComparatorFactoryClass(Class<? extends ComparatorFactory> comparatorFactoryClass)
Config_	withFilterClass(Class<? extends SelectionFilter> filterClass)
Config_	withFixedProbabilityWeight(Double fixedProbabilityWeight)
Config_	withProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)
Config_	withSelectedCountLimit(Long selectedCountLimit)
Config_	withSelectionOrder(SelectionOrder selectionOrder)
Config_	withSorterClass(Class<? extends SelectionSorter> sorterClass)
Config_	withSorterComparatorClass(Class<? extends Comparator> sorterComparatorClass)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of withComparatorClass(Class)
Config_	withSorterOrder(SelectionSorterOrder sorterOrder)
Config_	withSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of withComparatorFactoryClass(Class)

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 @Nullable SelectionCacheType cacheType

selectionOrder

protected @Nullable SelectionOrder selectionOrder

filterClass

protected @Nullable Class<? extends SelectionFilter> filterClass

sorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
protected @Nullable Class<? extends Comparator> sorterComparatorClass

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of comparatorClass.

comparatorClass

protected @Nullable Class<? extends Comparator> comparatorClass

sorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
protected @Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of comparatorFactoryClass.

comparatorFactoryClass

protected @Nullable Class<? extends ComparatorFactory> comparatorFactoryClass

sorterOrder

protected @Nullable SelectionSorterOrder sorterOrder

sorterClass

protected @Nullable Class<? extends SelectionSorter> sorterClass

probabilityWeightFactoryClass

protected @Nullable Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass

selectedCountLimit

protected @Nullable 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

@Deprecated(forRemoval=true,
            since="1.28.0")
public @Nullable Class<? extends Comparator> getSorterComparatorClass()

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of getComparatorClass()

setSorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public void setSorterComparatorClass(@Nullable Class<? extends Comparator> sorterComparatorClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of setComparatorClass(Class)

getComparatorClass

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

setComparatorClass

public void setComparatorClass(@Nullable Class<? extends Comparator> comparatorClass)

getSorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public @Nullable Class<? extends SelectionSorterWeightFactory> getSorterWeightFactoryClass()

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of getComparatorFactoryClass()

setSorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public void setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of setComparatorFactoryClass(Class)

Parameters:

sorterWeightFactoryClass - the class

getComparatorFactoryClass

public @Nullable Class<? extends ComparatorFactory> getComparatorFactoryClass()

setComparatorFactoryClass

public void setComparatorFactoryClass(@Nullable Class<? extends ComparatorFactory> comparatorFactoryClass)

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 Config_ withCacheType(SelectionCacheType cacheType)

withSelectionOrder

public Config_ withSelectionOrder(SelectionOrder selectionOrder)

withFilterClass

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

withSorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public Config_ withSorterComparatorClass(Class<? extends Comparator> sorterComparatorClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of withComparatorClass(Class)

withComparatorClass

public Config_ withComparatorClass(Class<? extends Comparator> comparatorClass)

withSorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public Config_ withSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of withComparatorFactoryClass(Class)

Parameters:

sorterWeightFactoryClass - the factory class

withComparatorFactoryClass

public Config_ withComparatorFactoryClass(Class<? extends ComparatorFactory> comparatorFactoryClass)

withSorterOrder

public Config_ withSorterOrder(SelectionSorterOrder sorterOrder)

withSorterClass

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

withProbabilityWeightFactoryClass

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

withSelectedCountLimit

public Config_ withSelectedCountLimit(Long selectedCountLimit)

withFixedProbabilityWeight

public Config_ withFixedProbabilityWeight(Double fixedProbabilityWeight)

extractLeafMoveSelectorConfigsIntoList

public void extractLeafMoveSelectorConfigsIntoList(List<MoveSelectorConfig> leafMoveSelectorConfigList)

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

inherit

public Config_ inherit(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(MoveSelectorConfig<?> foldedConfig)

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

visitCommonReferencedClasses

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