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

Class UnionMoveSelectorConfig

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<UnionMoveSelectorConfig>

ai.timefold.solver.core.config.heuristic.selector.move.composite.UnionMoveSelectorConfig

All Implemented Interfaces:

NearbyAutoConfigurationEnabled<UnionMoveSelectorConfig>

public class UnionMoveSelectorConfig
extends MoveSelectorConfig<UnionMoveSelectorConfig>
implements NearbyAutoConfigurationEnabled<UnionMoveSelectorConfig>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XML_ELEMENT_NAME

Fields inherited from class ai.timefold.solver.core.config.heuristic.selector.move.MoveSelectorConfig

cacheType, filterClass, probabilityWeightFactoryClass, selectedCountLimit, selectionOrder, sorterClass, sorterComparatorClass, sorterOrder, sorterWeightFactoryClass

Constructor Summary

Constructors

Constructor	Description
UnionMoveSelectorConfig()
UnionMoveSelectorConfig(List<MoveSelectorConfig> moveSelectorConfigList)

Method Summary

Modifier and Type	Method	Description
UnionMoveSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
UnionMoveSelectorConfig	enableNearbySelection(Class<? extends NearbyDistanceMeter<?,?>> distanceMeter, Random random)
void	extractLeafMoveSelectorConfigsIntoList(List<MoveSelectorConfig> leafMoveSelectorConfigList)	Gather a list of all descendant MoveSelectorConfigs except for UnionMoveSelectorConfig and CartesianProductMoveSelectorConfig.
List<MoveSelectorConfig>	getMoveSelectorConfigList()	Deprecated. Prefer getMoveSelectorList().
List<MoveSelectorConfig>	getMoveSelectorList()
Class<? extends SelectionProbabilityWeightFactory>	getSelectorProbabilityWeightFactoryClass()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
UnionMoveSelectorConfig	inherit(UnionMoveSelectorConfig 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	setMoveSelectorConfigList(List<MoveSelectorConfig> moveSelectorConfigList)	Deprecated. Prefer setMoveSelectorList(List).
void	setMoveSelectorList(List<MoveSelectorConfig> moveSelectorConfigList)
void	setSelectorProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> selectorProbabilityWeightFactoryClass)
String	toString()
void	visitReferencedClasses(Consumer<Class<?>> classVisitor)	Call the class visitor on each (possibly null) Class instance provided to this config by the user (including those provided in child configs).
UnionMoveSelectorConfig	withMoveSelectorList(List<MoveSelectorConfig> moveSelectorConfigList)
UnionMoveSelectorConfig	withMoveSelectors(MoveSelectorConfig... moveSelectorConfigs)
UnionMoveSelectorConfig	withSelectorProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> selectorProbabilityWeightFactoryClass)

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

getCacheType, getFilterClass, getFixedProbabilityWeight, getProbabilityWeightFactoryClass, getSelectedCountLimit, getSelectionOrder, getSorterClass, getSorterComparatorClass, getSorterOrder, getSorterWeightFactoryClass, inheritFolded, setCacheType, setFilterClass, setFixedProbabilityWeight, setProbabilityWeightFactoryClass, setSelectedCountLimit, setSelectionOrder, setSorterClass, setSorterComparatorClass, setSorterOrder, setSorterWeightFactoryClass, visitCommonReferencedClasses, withCacheType, withFilterClass, withFixedProbabilityWeight, withProbabilityWeightFactoryClass, withSelectedCountLimit, withSelectionOrder, withSorterClass, withSorterComparatorClass, withSorterOrder, withSorterWeightFactoryClass

Methods inherited from class java.lang.Object

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

Field Details

XML_ELEMENT_NAME

public static final String XML_ELEMENT_NAME

See Also:

• Constant Field Values

Constructor Details

UnionMoveSelectorConfig

public UnionMoveSelectorConfig()

UnionMoveSelectorConfig

public UnionMoveSelectorConfig(List<MoveSelectorConfig> moveSelectorConfigList)

Method Details

getMoveSelectorConfigList

@Deprecated
public List<MoveSelectorConfig> getMoveSelectorConfigList()

Deprecated.

Prefer getMoveSelectorList().

Returns:

sometimes null

setMoveSelectorConfigList

@Deprecated
public void setMoveSelectorConfigList(List<MoveSelectorConfig> moveSelectorConfigList)

Deprecated.

Prefer setMoveSelectorList(List).

Parameters:

moveSelectorConfigList - sometimes null

getMoveSelectorList

public List<MoveSelectorConfig> getMoveSelectorList()

setMoveSelectorList

public void setMoveSelectorList(List<MoveSelectorConfig> moveSelectorConfigList)

getSelectorProbabilityWeightFactoryClass

public Class<? extends SelectionProbabilityWeightFactory> getSelectorProbabilityWeightFactoryClass()

setSelectorProbabilityWeightFactoryClass

public void setSelectorProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> selectorProbabilityWeightFactoryClass)

withMoveSelectorList

public UnionMoveSelectorConfig withMoveSelectorList(List<MoveSelectorConfig> moveSelectorConfigList)

withMoveSelectors

public UnionMoveSelectorConfig withMoveSelectors(MoveSelectorConfig... moveSelectorConfigs)

withSelectorProbabilityWeightFactoryClass

public UnionMoveSelectorConfig withSelectorProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> selectorProbabilityWeightFactoryClass)

extractLeafMoveSelectorConfigsIntoList

public void extractLeafMoveSelectorConfigsIntoList(List<MoveSelectorConfig> leafMoveSelectorConfigList)

Description copied from class: MoveSelectorConfig

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

Overrides:

extractLeafMoveSelectorConfigsIntoList in class MoveSelectorConfig<UnionMoveSelectorConfig>

Parameters:

leafMoveSelectorConfigList - not null

inherit

public UnionMoveSelectorConfig inherit(UnionMoveSelectorConfig 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.

Overrides:

inherit in class MoveSelectorConfig<UnionMoveSelectorConfig>

Parameters:

inheritedConfig - never null

Returns:

this

copyConfig

public UnionMoveSelectorConfig copyConfig()

Description copied from class: AbstractConfig

Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.

Specified by:

copyConfig in class AbstractConfig<UnionMoveSelectorConfig>

Returns:

new instance

visitReferencedClasses

public void visitReferencedClasses(Consumer<Class<?>> classVisitor)

Description copied from class: AbstractConfig

Call the class visitor on each (possibly null) Class instance provided to this config by the user (including those provided in child configs). Required to create the bean factory in Quarkus.

Specified by:

visitReferencedClasses in class AbstractConfig<UnionMoveSelectorConfig>

Parameters:

classVisitor - The visitor of classes, never null. Can accept null instances of Class.

enableNearbySelection

public UnionMoveSelectorConfig enableNearbySelection(Class<? extends NearbyDistanceMeter<?,?>> distanceMeter,
 Random random)

Specified by:

enableNearbySelection in interface NearbyAutoConfigurationEnabled<UnionMoveSelectorConfig>

Returns:

new instance with the Nearby Selection settings properly configured

hasNearbySelectionConfig

public boolean hasNearbySelectionConfig()

Description copied from class: SelectorConfig

Verifies if the current configuration has any Nearby Selection settings.

Specified by:

hasNearbySelectionConfig in class SelectorConfig<UnionMoveSelectorConfig>

toString

public String toString()

Overrides:

toString in class AbstractConfig<UnionMoveSelectorConfig>