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

Class SwapMoveSelectorConfig

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

ai.timefold.solver.core.config.heuristic.selector.move.generic.SwapMoveSelectorConfig

All Implemented Interfaces:

NearbyAutoConfigurationEnabled<SwapMoveSelectorConfig>

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

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
SwapMoveSelectorConfig()

Method Summary

Modifier and Type	Method	Description
boolean	canEnableNearbyInMixedModels()
@NonNull SwapMoveSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@NonNull SwapMoveSelectorConfig	enableNearbySelection(@NonNull Class<? extends NearbyDistanceMeter<?,?>> distanceMeter, @NonNull Random random)
@Nullable EntitySelectorConfig	getEntitySelectorConfig()
@Nullable EntitySelectorConfig	getSecondaryEntitySelectorConfig()
@Nullable List<@NonNull String>	getVariableNameIncludeList()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
@NonNull SwapMoveSelectorConfig	inherit(@NonNull SwapMoveSelectorConfig 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	setEntitySelectorConfig(@Nullable EntitySelectorConfig entitySelectorConfig)
void	setSecondaryEntitySelectorConfig(@Nullable EntitySelectorConfig secondaryEntitySelectorConfig)
void	setVariableNameIncludeList(@Nullable List<@NonNull String> variableNameIncludeList)
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 SwapMoveSelectorConfig	withEntitySelectorConfig(@NonNull EntitySelectorConfig entitySelectorConfig)
@NonNull SwapMoveSelectorConfig	withSecondaryEntitySelectorConfig(@NonNull EntitySelectorConfig secondaryEntitySelectorConfig)
@NonNull SwapMoveSelectorConfig	withVariableNameIncludes(@NonNull String @NonNull ... variableNameIncludes)

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

extractLeafMoveSelectorConfigsIntoList, 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

SwapMoveSelectorConfig

public SwapMoveSelectorConfig()

Method Details

getEntitySelectorConfig

public @Nullable EntitySelectorConfig getEntitySelectorConfig()

setEntitySelectorConfig

public void setEntitySelectorConfig(@Nullable EntitySelectorConfig entitySelectorConfig)

getSecondaryEntitySelectorConfig

public @Nullable EntitySelectorConfig getSecondaryEntitySelectorConfig()

setSecondaryEntitySelectorConfig

public void setSecondaryEntitySelectorConfig(@Nullable EntitySelectorConfig secondaryEntitySelectorConfig)

getVariableNameIncludeList

public @Nullable List<@NonNull String> getVariableNameIncludeList()

setVariableNameIncludeList

public void setVariableNameIncludeList(@Nullable List<@NonNull String> variableNameIncludeList)

withEntitySelectorConfig

public @NonNull SwapMoveSelectorConfig withEntitySelectorConfig(@NonNull EntitySelectorConfig entitySelectorConfig)

withSecondaryEntitySelectorConfig

public @NonNull SwapMoveSelectorConfig withSecondaryEntitySelectorConfig(@NonNull EntitySelectorConfig secondaryEntitySelectorConfig)

withVariableNameIncludes

public @NonNull SwapMoveSelectorConfig withVariableNameIncludes(@NonNull String @NonNull ... variableNameIncludes)

inherit

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

Returns:

this

copyConfig

public @NonNull SwapMoveSelectorConfig 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<SwapMoveSelectorConfig>

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

Parameters:

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

enableNearbySelection

public @NonNull SwapMoveSelectorConfig enableNearbySelection(@NonNull Class<? extends NearbyDistanceMeter<?,?>> distanceMeter,
 @NonNull Random random)

Specified by:

enableNearbySelection in interface NearbyAutoConfigurationEnabled<SwapMoveSelectorConfig>

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

canEnableNearbyInMixedModels

public boolean canEnableNearbyInMixedModels()

Specified by:

canEnableNearbyInMixedModels in interface NearbyAutoConfigurationEnabled<SwapMoveSelectorConfig>

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