Package ai.timefold.solver.core.config.localsearch

Class LocalSearchPhaseConfig

java.lang.Object

ai.timefold.solver.core.config.AbstractConfig<Config_>

ai.timefold.solver.core.config.phase.PhaseConfig<LocalSearchPhaseConfig>

ai.timefold.solver.core.config.localsearch.LocalSearchPhaseConfig

public class LocalSearchPhaseConfig
extends PhaseConfig<LocalSearchPhaseConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected LocalSearchType	localSearchType
static final String	XML_ELEMENT_NAME

Fields inherited from class ai.timefold.solver.core.config.phase.PhaseConfig

terminationConfig

Constructor Summary

Constructors

Constructor	Description
LocalSearchPhaseConfig()

Method Summary

Modifier and Type	Method	Description
@NonNull LocalSearchPhaseConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@Nullable LocalSearchAcceptorConfig	getAcceptorConfig()
@Nullable LocalSearchForagerConfig	getForagerConfig()
@Nullable LocalSearchType	getLocalSearchType()
@Nullable MoveSelectorConfig	getMoveSelectorConfig()
<Solution_> @Nullable Class<? extends NeighborhoodProvider<Solution_>>	getNeighborhoodProviderClass()	The neighborhood provider class to use.
@NonNull LocalSearchPhaseConfig	inherit(@NonNull LocalSearchPhaseConfig 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	setAcceptorConfig(@Nullable LocalSearchAcceptorConfig acceptorConfig)
void	setForagerConfig(@Nullable LocalSearchForagerConfig foragerConfig)
void	setLocalSearchType(@Nullable LocalSearchType localSearchType)
void	setMoveSelectorConfig(@Nullable MoveSelectorConfig moveSelectorConfig)
void	setNeighborhoodProviderClass(@Nullable Class<? extends NeighborhoodProvider> neighborhoodProviderClass)
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 LocalSearchPhaseConfig	withAcceptorConfig(@NonNull LocalSearchAcceptorConfig acceptorConfig)
@NonNull LocalSearchPhaseConfig	withForagerConfig(@NonNull LocalSearchForagerConfig foragerConfig)
@NonNull LocalSearchPhaseConfig	withLocalSearchType(@NonNull LocalSearchType localSearchType)
@NonNull LocalSearchPhaseConfig	withMoveProviderClass(@NonNull Class<? extends NeighborhoodProvider<?>> moveProviderClass)	Part of PreviewFeature.NEIGHBORHOODS.
@NonNull LocalSearchPhaseConfig	withMoveSelectorConfig(@NonNull MoveSelectorConfig moveSelectorConfig)

Methods inherited from class ai.timefold.solver.core.config.phase.PhaseConfig

getTerminationConfig, setTerminationConfig, toString, withTerminationConfig

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

localSearchType

protected LocalSearchType localSearchType

Constructor Details

LocalSearchPhaseConfig

public LocalSearchPhaseConfig()

Method Details

getLocalSearchType

public @Nullable LocalSearchType getLocalSearchType()

setLocalSearchType

public void setLocalSearchType(@Nullable LocalSearchType localSearchType)

getMoveSelectorConfig

public @Nullable MoveSelectorConfig getMoveSelectorConfig()

setMoveSelectorConfig

public void setMoveSelectorConfig(@Nullable MoveSelectorConfig moveSelectorConfig)

getNeighborhoodProviderClass

public <Solution_>
@Nullable Class<? extends NeighborhoodProvider<Solution_>> getNeighborhoodProviderClass()

The neighborhood provider class to use. If no MoveSelectorConfig is specified, the solver will use Neighborhoods exclusively. Otherwise the move selector config will be merged with the neighborhood provider, and the solver will use moves from both.

Part of PreviewFeature.NEIGHBORHOODS.

setNeighborhoodProviderClass

public void setNeighborhoodProviderClass(@Nullable Class<? extends NeighborhoodProvider> neighborhoodProviderClass)

See Also:

• getNeighborhoodProviderClass()

getAcceptorConfig

public @Nullable LocalSearchAcceptorConfig getAcceptorConfig()

setAcceptorConfig

public void setAcceptorConfig(@Nullable LocalSearchAcceptorConfig acceptorConfig)

getForagerConfig

public @Nullable LocalSearchForagerConfig getForagerConfig()

setForagerConfig

public void setForagerConfig(@Nullable LocalSearchForagerConfig foragerConfig)

withLocalSearchType

public @NonNull LocalSearchPhaseConfig withLocalSearchType(@NonNull LocalSearchType localSearchType)

withMoveSelectorConfig

public @NonNull LocalSearchPhaseConfig withMoveSelectorConfig(@NonNull MoveSelectorConfig moveSelectorConfig)

withMoveProviderClass

public @NonNull LocalSearchPhaseConfig withMoveProviderClass(@NonNull Class<? extends NeighborhoodProvider<?>> moveProviderClass)

Part of PreviewFeature.NEIGHBORHOODS.

withAcceptorConfig

public @NonNull LocalSearchPhaseConfig withAcceptorConfig(@NonNull LocalSearchAcceptorConfig acceptorConfig)

withForagerConfig

public @NonNull LocalSearchPhaseConfig withForagerConfig(@NonNull LocalSearchForagerConfig foragerConfig)

inherit

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

Returns:

this

copyConfig

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

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

Parameters:

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