Package ai.timefold.solver.core.config.partitionedsearch

Class PartitionedSearchPhaseConfig

java.lang.Object

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

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

ai.timefold.solver.core.config.partitionedsearch.PartitionedSearchPhaseConfig

public class PartitionedSearchPhaseConfig
extends PhaseConfig<PartitionedSearchPhaseConfig>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVE_THREAD_COUNT_AUTO
static final String	ACTIVE_THREAD_COUNT_UNLIMITED
protected List<PhaseConfig>	phaseConfigList
protected String	runnablePartThreadLimit
protected Class<? extends SolutionPartitioner<?>>	solutionPartitionerClass
protected Map<String,String>	solutionPartitionerCustomProperties
static final String	XML_ELEMENT_NAME

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

terminationConfig

Constructor Summary

Constructors

Constructor	Description
PartitionedSearchPhaseConfig()

Method Summary

Modifier and Type	Method	Description
@NonNull PartitionedSearchPhaseConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
@Nullable List<@NonNull PhaseConfig>	getPhaseConfigList()
@Nullable String	getRunnablePartThreadLimit()	Similar to a thread pool size, but instead of limiting the number of Threads, it limits the number of runnable Threads to avoid consuming all CPU resources (which would starve UI, Servlets and REST threads).
@Nullable Class<? extends SolutionPartitioner<?>>	getSolutionPartitionerClass()
@Nullable Map<String,String>	getSolutionPartitionerCustomProperties()
@NonNull PartitionedSearchPhaseConfig	inherit(@NonNull PartitionedSearchPhaseConfig 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	setPhaseConfigList(@Nullable List<@NonNull PhaseConfig> phaseConfigList)
void	setRunnablePartThreadLimit(@Nullable String runnablePartThreadLimit)
void	setSolutionPartitionerClass(@Nullable Class<? extends SolutionPartitioner<?>> solutionPartitionerClass)
void	setSolutionPartitionerCustomProperties(@Nullable Map<String,String> solutionPartitionerCustomProperties)
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 PartitionedSearchPhaseConfig	withPhaseConfigList(@NonNull List<@NonNull PhaseConfig> phaseConfigList)
@NonNull PartitionedSearchPhaseConfig	withPhaseConfigs(@NonNull PhaseConfig @NonNull ... phaseConfigs)
@NonNull PartitionedSearchPhaseConfig	withRunnablePartThreadLimit(@NonNull String runnablePartThreadLimit)
@NonNull PartitionedSearchPhaseConfig	withSolutionPartitionerClass(@NonNull Class<? extends SolutionPartitioner<?>> solutionPartitionerClass)
@NonNull PartitionedSearchPhaseConfig	withSolutionPartitionerCustomProperties(@NonNull Map<String,String> solutionPartitionerCustomProperties)

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

ACTIVE_THREAD_COUNT_AUTO

public static final String ACTIVE_THREAD_COUNT_AUTO

See Also:

• Constant Field Values

ACTIVE_THREAD_COUNT_UNLIMITED

public static final String ACTIVE_THREAD_COUNT_UNLIMITED

See Also:

• Constant Field Values

solutionPartitionerClass

protected Class<? extends SolutionPartitioner<?>> solutionPartitionerClass

solutionPartitionerCustomProperties

protected Map<String,String> solutionPartitionerCustomProperties

runnablePartThreadLimit

protected String runnablePartThreadLimit

phaseConfigList

protected List<PhaseConfig> phaseConfigList

Constructor Details

PartitionedSearchPhaseConfig

public PartitionedSearchPhaseConfig()

Method Details

getSolutionPartitionerClass

public @Nullable Class<? extends SolutionPartitioner<?>> getSolutionPartitionerClass()

setSolutionPartitionerClass

public void setSolutionPartitionerClass(@Nullable Class<? extends SolutionPartitioner<?>> solutionPartitionerClass)

getSolutionPartitionerCustomProperties

public @Nullable Map<String,String> getSolutionPartitionerCustomProperties()

setSolutionPartitionerCustomProperties

public void setSolutionPartitionerCustomProperties(@Nullable Map<String,String> solutionPartitionerCustomProperties)

getRunnablePartThreadLimit

public @Nullable String getRunnablePartThreadLimit()

Similar to a thread pool size, but instead of limiting the number of Threads, it limits the number of runnable Threads to avoid consuming all CPU resources (which would starve UI, Servlets and REST threads).

The number of Threads is always equal to the number of partitions returned by SolutionPartitioner.splitWorkingSolution(ScoreDirector, Integer), because otherwise some partitions would never run (especially with asynchronous termination). If this limit (or Runtime.availableProcessors()) is lower than the number of partitions, this results in a slower score calculation speed per partition Solver.

Defaults to "AUTO" which consumes the majority but not all of the CPU cores on multi-core machines, to prevent a livelock that hangs other processes (such as your IDE, REST servlets threads or SSH connections) on the machine.

Use "UNLIMITED" to give it all CPU cores. This is useful if you're handling the CPU consumption on an OS level.

Returns:

null, a number, "AUTO" or "UNLIMITED".

setRunnablePartThreadLimit

public void setRunnablePartThreadLimit(@Nullable String runnablePartThreadLimit)

getPhaseConfigList

public @Nullable List<@NonNull PhaseConfig> getPhaseConfigList()

setPhaseConfigList

public void setPhaseConfigList(@Nullable List<@NonNull PhaseConfig> phaseConfigList)

withSolutionPartitionerClass

public @NonNull PartitionedSearchPhaseConfig withSolutionPartitionerClass(@NonNull Class<? extends SolutionPartitioner<?>> solutionPartitionerClass)

withSolutionPartitionerCustomProperties

public @NonNull PartitionedSearchPhaseConfig withSolutionPartitionerCustomProperties(@NonNull Map<String,String> solutionPartitionerCustomProperties)

withRunnablePartThreadLimit

public @NonNull PartitionedSearchPhaseConfig withRunnablePartThreadLimit(@NonNull String runnablePartThreadLimit)

withPhaseConfigList

public @NonNull PartitionedSearchPhaseConfig withPhaseConfigList(@NonNull List<@NonNull PhaseConfig> phaseConfigList)

withPhaseConfigs

public @NonNull PartitionedSearchPhaseConfig withPhaseConfigs(@NonNull PhaseConfig @NonNull ... phaseConfigs)

inherit

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

Returns:

this

copyConfig

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

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

Parameters:

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