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

setMinimumK

public void setMinimumK(Integer minimumK)

getMaximumK

public Integer getMaximumK()

setMaximumK

public void setMaximumK(Integer maximumK)

getOriginSelectorConfig

public ValueSelectorConfig getOriginSelectorConfig()

setOriginSelectorConfig

public void setOriginSelectorConfig(ValueSelectorConfig originSelectorConfig)

getValueSelectorConfig

public ValueSelectorConfig getValueSelectorConfig()

setValueSelectorConfig

public void setValueSelectorConfig(ValueSelectorConfig valueSelectorConfig)

withMinimumK

public KOptListMoveSelectorConfig withMinimumK(Integer minimumK)

withMaximumK

public KOptListMoveSelectorConfig withMaximumK(Integer maximumK)

withOriginSelectorConfig

public KOptListMoveSelectorConfig withOriginSelectorConfig(ValueSelectorConfig originSelectorConfig)

withValueSelectorConfig

public KOptListMoveSelectorConfig withValueSelectorConfig(ValueSelectorConfig valueSelectorConfig)

inherit

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

Parameters:

inheritedConfig - never null

Returns:

this

copyConfig

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

enableNearbySelection

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

toString

public String toString()

Overrides:

toString in class AbstractConfig<KOptListMoveSelectorConfig>