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

Class ListSwapMoveSelectorConfig

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

ai.timefold.solver.core.config.heuristic.selector.move.generic.list.ListSwapMoveSelectorConfig

All Implemented Interfaces:

NearbyAutoConfigurationEnabled<ListSwapMoveSelectorConfig>

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

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

Method Summary

Modifier and Type	Method	Description
boolean	canEnableNearbyInMixedModels()
@NonNull ListSwapMoveSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@NonNull ListSwapMoveSelectorConfig	enableNearbySelection(@NonNull Class<? extends NearbyDistanceMeter<?,?>> distanceMeter, @NonNull Random random)
@Nullable ValueSelectorConfig	getSecondaryValueSelectorConfig()
@Nullable ValueSelectorConfig	getValueSelectorConfig()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
@NonNull ListSwapMoveSelectorConfig	inherit(@NonNull ListSwapMoveSelectorConfig 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	setSecondaryValueSelectorConfig(@Nullable ValueSelectorConfig secondaryValueSelectorConfig)
void	setValueSelectorConfig(@Nullable ValueSelectorConfig valueSelectorConfig)
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 ListSwapMoveSelectorConfig	withSecondaryValueSelectorConfig(@NonNull ValueSelectorConfig secondaryValueSelectorConfig)
@NonNull ListSwapMoveSelectorConfig	withValueSelectorConfig(@NonNull ValueSelectorConfig valueSelectorConfig)

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

ListSwapMoveSelectorConfig

public ListSwapMoveSelectorConfig()

Method Details

getValueSelectorConfig

public @Nullable ValueSelectorConfig getValueSelectorConfig()

setValueSelectorConfig

public void setValueSelectorConfig(@Nullable ValueSelectorConfig valueSelectorConfig)

getSecondaryValueSelectorConfig

public @Nullable ValueSelectorConfig getSecondaryValueSelectorConfig()

setSecondaryValueSelectorConfig

public void setSecondaryValueSelectorConfig(@Nullable ValueSelectorConfig secondaryValueSelectorConfig)

withValueSelectorConfig

public @NonNull ListSwapMoveSelectorConfig withValueSelectorConfig(@NonNull ValueSelectorConfig valueSelectorConfig)

withSecondaryValueSelectorConfig

public @NonNull ListSwapMoveSelectorConfig withSecondaryValueSelectorConfig(@NonNull ValueSelectorConfig secondaryValueSelectorConfig)

inherit

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

Returns:

this

copyConfig

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

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

Parameters:

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

enableNearbySelection

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

Specified by:

enableNearbySelection in interface NearbyAutoConfigurationEnabled<ListSwapMoveSelectorConfig>

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

canEnableNearbyInMixedModels

public boolean canEnableNearbyInMixedModels()

Specified by:

canEnableNearbyInMixedModels in interface NearbyAutoConfigurationEnabled<ListSwapMoveSelectorConfig>

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