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(@NonNull List<@NonNull MoveSelectorConfig> moveSelectorConfigList)

Method Summary

Modifier and Type	Method	Description
boolean	canEnableNearbyInMixedModels()
@NonNull UnionMoveSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@NonNull UnionMoveSelectorConfig	enableNearbySelection(@NonNull Class<? extends NearbyDistanceMeter<?,?>> distanceMeter, @NonNull Random random)
void	extractLeafMoveSelectorConfigsIntoList(@NonNull List<@NonNull MoveSelectorConfig> leafMoveSelectorConfigList)	Gather a list of all descendant MoveSelectorConfigs except for UnionMoveSelectorConfig and CartesianProductMoveSelectorConfig.
List<MoveSelectorConfig>	getMoveSelectorConfigList()	Deprecated. Prefer getMoveSelectorList().
@Nullable List<@NonNull MoveSelectorConfig>	getMoveSelectorList()
@Nullable Class<? extends SelectionProbabilityWeightFactory>	getSelectorProbabilityWeightFactoryClass()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
@NonNull UnionMoveSelectorConfig	inherit(@NonNull 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(@Nullable List<@NonNull MoveSelectorConfig> moveSelectorConfigList)
void	setSelectorProbabilityWeightFactoryClass(@Nullable Class<? extends SelectionProbabilityWeightFactory> selectorProbabilityWeightFactoryClass)
String	toString()
void	visitReferencedClasses(@NonNull 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).
@NonNull UnionMoveSelectorConfig	withMoveSelectorList(@NonNull List<@NonNull MoveSelectorConfig> moveSelectorConfigList)
@NonNull UnionMoveSelectorConfig	withMoveSelectors(@NonNull MoveSelectorConfig @NonNull ... moveSelectorConfigs)
@NonNull UnionMoveSelectorConfig	withSelectorProbabilityWeightFactoryClass(@NonNull 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(@NonNull List<@NonNull 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 @Nullable List<@NonNull MoveSelectorConfig> getMoveSelectorList()

setMoveSelectorList

public void setMoveSelectorList(@Nullable List<@NonNull MoveSelectorConfig> moveSelectorConfigList)

getSelectorProbabilityWeightFactoryClass

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

setSelectorProbabilityWeightFactoryClass

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

withMoveSelectorList

public @NonNull UnionMoveSelectorConfig withMoveSelectorList(@NonNull List<@NonNull MoveSelectorConfig> moveSelectorConfigList)

withMoveSelectors

public @NonNull UnionMoveSelectorConfig withMoveSelectors(@NonNull MoveSelectorConfig @NonNull ... moveSelectorConfigs)

withSelectorProbabilityWeightFactoryClass

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

extractLeafMoveSelectorConfigsIntoList

public void extractLeafMoveSelectorConfigsIntoList(@NonNull List<@NonNull 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>

inherit

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

Returns:

this

copyConfig

public @NonNull 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(@NonNull 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. Can accept null instances of Class.

enableNearbySelection

public @NonNull UnionMoveSelectorConfig enableNearbySelection(@NonNull Class<? extends NearbyDistanceMeter<?,?>> distanceMeter,
 @NonNull 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>

canEnableNearbyInMixedModels

public boolean canEnableNearbyInMixedModels()

Specified by:

canEnableNearbyInMixedModels in interface NearbyAutoConfigurationEnabled<UnionMoveSelectorConfig>

Returns:

true if it can enable the nearby setting for the given move configuration; otherwise, it returns false.

toString

public String toString()

Overrides:

toString in class AbstractConfig<UnionMoveSelectorConfig>