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

Class KOptListMoveSelectorConfig

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

ai.timefold.solver.core.config.heuristic.selector.move.generic.list.kopt.KOptListMoveSelectorConfig

All Implemented Interfaces:

NearbyAutoConfigurationEnabled<KOptListMoveSelectorConfig>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Integer	maximumK
protected Integer	minimumK
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
KOptListMoveSelectorConfig()

Method Summary

Modifier and Type	Method	Description
boolean	canEnableNearbyInMixedModels()
@NonNull KOptListMoveSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@NonNull KOptListMoveSelectorConfig	enableNearbySelection(@NonNull Class<? extends NearbyDistanceMeter<?,?>> distanceMeter, @NonNull Random random)
@Nullable Integer	getMaximumK()
@Nullable Integer	getMinimumK()
@Nullable ValueSelectorConfig	getOriginSelectorConfig()
@Nullable ValueSelectorConfig	getValueSelectorConfig()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
@NonNull KOptListMoveSelectorConfig	inherit(@NonNull KOptListMoveSelectorConfig 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	setMaximumK(@Nullable Integer maximumK)
void	setMinimumK(@Nullable Integer minimumK)
void	setOriginSelectorConfig(@Nullable ValueSelectorConfig originSelectorConfig)
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 KOptListMoveSelectorConfig	withMaximumK(@NonNull Integer maximumK)
@NonNull KOptListMoveSelectorConfig	withMinimumK(@NonNull Integer minimumK)
@NonNull KOptListMoveSelectorConfig	withOriginSelectorConfig(@NonNull ValueSelectorConfig originSelectorConfig)
@NonNull KOptListMoveSelectorConfig	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

minimumK

protected Integer minimumK

maximumK

protected Integer maximumK

Constructor Details

KOptListMoveSelectorConfig

public KOptListMoveSelectorConfig()

Method Details

getMinimumK

public @Nullable Integer getMinimumK()

setMinimumK

public void setMinimumK(@Nullable Integer minimumK)

getMaximumK

public @Nullable Integer getMaximumK()

setMaximumK

public void setMaximumK(@Nullable Integer maximumK)

getOriginSelectorConfig

public @Nullable ValueSelectorConfig getOriginSelectorConfig()

setOriginSelectorConfig

public void setOriginSelectorConfig(@Nullable ValueSelectorConfig originSelectorConfig)

getValueSelectorConfig

public @Nullable ValueSelectorConfig getValueSelectorConfig()

setValueSelectorConfig

public void setValueSelectorConfig(@Nullable ValueSelectorConfig valueSelectorConfig)

withMinimumK

public @NonNull KOptListMoveSelectorConfig withMinimumK(@NonNull Integer minimumK)

withMaximumK

public @NonNull KOptListMoveSelectorConfig withMaximumK(@NonNull Integer maximumK)

withOriginSelectorConfig

public @NonNull KOptListMoveSelectorConfig withOriginSelectorConfig(@NonNull ValueSelectorConfig originSelectorConfig)

withValueSelectorConfig

public @NonNull KOptListMoveSelectorConfig withValueSelectorConfig(@NonNull ValueSelectorConfig valueSelectorConfig)

inherit

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

Returns:

this

copyConfig

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

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

Parameters:

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

enableNearbySelection

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

Specified by:

enableNearbySelection in interface NearbyAutoConfigurationEnabled<KOptListMoveSelectorConfig>

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

canEnableNearbyInMixedModels

public boolean canEnableNearbyInMixedModels()

Specified by:

canEnableNearbyInMixedModels in interface NearbyAutoConfigurationEnabled<KOptListMoveSelectorConfig>

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