Package ai.timefold.solver.core.config.heuristic.selector.common.nearby

Class NearbySelectionConfig

java.lang.Object

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

ai.timefold.solver.core.config.heuristic.selector.SelectorConfig<NearbySelectionConfig>

ai.timefold.solver.core.config.heuristic.selector.common.nearby.NearbySelectionConfig

public class NearbySelectionConfig
extends SelectorConfig<NearbySelectionConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected Double	betaDistributionAlpha
protected Double	betaDistributionBeta
protected Integer	blockDistributionSizeMaximum
protected Integer	blockDistributionSizeMinimum
protected Double	blockDistributionSizeRatio
protected Double	blockDistributionUniformDistributionProbability
protected Integer	linearDistributionSizeMaximum
protected Class<? extends NearbyDistanceMeter>	nearbyDistanceMeterClass
protected NearbySelectionDistributionType	nearbySelectionDistributionType
protected EntitySelectorConfig	originEntitySelectorConfig
protected SubListSelectorConfig	originSubListSelectorConfig
protected ValueSelectorConfig	originValueSelectorConfig
protected Integer	parabolicDistributionSizeMaximum

Constructor Summary

Constructors

Constructor	Description
NearbySelectionConfig()

Method Summary

Modifier and Type	Method	Description
NearbySelectionConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
Double	getBetaDistributionAlpha()
Double	getBetaDistributionBeta()
Integer	getBlockDistributionSizeMaximum()
Integer	getBlockDistributionSizeMinimum()
Double	getBlockDistributionSizeRatio()
Double	getBlockDistributionUniformDistributionProbability()
Integer	getLinearDistributionSizeMaximum()
Class<? extends NearbyDistanceMeter>	getNearbyDistanceMeterClass()
NearbySelectionDistributionType	getNearbySelectionDistributionType()
EntitySelectorConfig	getOriginEntitySelectorConfig()
SubListSelectorConfig	getOriginSubListSelectorConfig()
ValueSelectorConfig	getOriginValueSelectorConfig()
Integer	getParabolicDistributionSizeMaximum()
NearbySelectionConfig	inherit(NearbySelectionConfig 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	setBetaDistributionAlpha(Double betaDistributionAlpha)
void	setBetaDistributionBeta(Double betaDistributionBeta)
void	setBlockDistributionSizeMaximum(Integer blockDistributionSizeMaximum)
void	setBlockDistributionSizeMinimum(Integer blockDistributionSizeMinimum)
void	setBlockDistributionSizeRatio(Double blockDistributionSizeRatio)
void	setBlockDistributionUniformDistributionProbability(Double blockDistributionUniformDistributionProbability)
void	setLinearDistributionSizeMaximum(Integer linearDistributionSizeMaximum)
void	setNearbyDistanceMeterClass(Class<? extends NearbyDistanceMeter> nearbyDistanceMeterClass)
void	setNearbySelectionDistributionType(NearbySelectionDistributionType nearbySelectionDistributionType)
void	setOriginEntitySelectorConfig(EntitySelectorConfig originEntitySelectorConfig)
void	setOriginSubListSelectorConfig(SubListSelectorConfig originSubListSelectorConfig)
void	setOriginValueSelectorConfig(ValueSelectorConfig originValueSelectorConfig)
void	setParabolicDistributionSizeMaximum(Integer parabolicDistributionSizeMaximum)
void	validateNearby(SelectionCacheType resolvedCacheType, SelectionOrder resolvedSelectionOrder)
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).
NearbySelectionConfig	withBetaDistributionAlpha(Double betaDistributionAlpha)
NearbySelectionConfig	withBetaDistributionBeta(Double betaDistributionBeta)
NearbySelectionConfig	withBlockDistributionSizeMaximum(Integer blockDistributionSizeMaximum)
NearbySelectionConfig	withBlockDistributionSizeMinimum(Integer blockDistributionSizeMinimum)
NearbySelectionConfig	withBlockDistributionSizeRatio(Double blockDistributionSizeRatio)
NearbySelectionConfig	withBlockDistributionUniformDistributionProbability(Double blockDistributionUniformDistributionProbability)
NearbySelectionConfig	withLinearDistributionSizeMaximum(Integer linearDistributionSizeMaximum)
NearbySelectionConfig	withNearbyDistanceMeterClass(Class<? extends NearbyDistanceMeter> nearbyDistanceMeterClass)
NearbySelectionConfig	withNearbySelectionDistributionType(NearbySelectionDistributionType nearbySelectionDistributionType)
NearbySelectionConfig	withOriginEntitySelectorConfig(EntitySelectorConfig originEntitySelectorConfig)
NearbySelectionConfig	withOriginSubListSelectorConfig(SubListSelectorConfig originSubListSelectorConfig)
NearbySelectionConfig	withOriginValueSelectorConfig(ValueSelectorConfig originValueSelectorConfig)
NearbySelectionConfig	withParabolicDistributionSizeMaximum(Integer parabolicDistributionSizeMaximum)

Methods inherited from class ai.timefold.solver.core.config.AbstractConfig

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

originEntitySelectorConfig

protected EntitySelectorConfig originEntitySelectorConfig

originSubListSelectorConfig

protected SubListSelectorConfig originSubListSelectorConfig

originValueSelectorConfig

protected ValueSelectorConfig originValueSelectorConfig

nearbyDistanceMeterClass

protected Class<? extends NearbyDistanceMeter> nearbyDistanceMeterClass

nearbySelectionDistributionType

protected NearbySelectionDistributionType nearbySelectionDistributionType

blockDistributionSizeMinimum

protected Integer blockDistributionSizeMinimum

blockDistributionSizeMaximum

protected Integer blockDistributionSizeMaximum

blockDistributionSizeRatio

protected Double blockDistributionSizeRatio

blockDistributionUniformDistributionProbability

protected Double blockDistributionUniformDistributionProbability

linearDistributionSizeMaximum

protected Integer linearDistributionSizeMaximum

parabolicDistributionSizeMaximum

protected Integer parabolicDistributionSizeMaximum

betaDistributionAlpha

protected Double betaDistributionAlpha

betaDistributionBeta

protected Double betaDistributionBeta

Constructor Detail

NearbySelectionConfig

public NearbySelectionConfig()

Method Detail

getOriginEntitySelectorConfig

public EntitySelectorConfig getOriginEntitySelectorConfig()

setOriginEntitySelectorConfig

public void setOriginEntitySelectorConfig(EntitySelectorConfig originEntitySelectorConfig)

getOriginSubListSelectorConfig

public SubListSelectorConfig getOriginSubListSelectorConfig()

setOriginSubListSelectorConfig

public void setOriginSubListSelectorConfig(SubListSelectorConfig originSubListSelectorConfig)

getOriginValueSelectorConfig

public ValueSelectorConfig getOriginValueSelectorConfig()

setOriginValueSelectorConfig

public void setOriginValueSelectorConfig(ValueSelectorConfig originValueSelectorConfig)

getNearbyDistanceMeterClass

public Class<? extends NearbyDistanceMeter> getNearbyDistanceMeterClass()

setNearbyDistanceMeterClass

public void setNearbyDistanceMeterClass(Class<? extends NearbyDistanceMeter> nearbyDistanceMeterClass)

getNearbySelectionDistributionType

public NearbySelectionDistributionType getNearbySelectionDistributionType()

setNearbySelectionDistributionType

public void setNearbySelectionDistributionType(NearbySelectionDistributionType nearbySelectionDistributionType)

getBlockDistributionSizeMinimum

public Integer getBlockDistributionSizeMinimum()

setBlockDistributionSizeMinimum

public void setBlockDistributionSizeMinimum(Integer blockDistributionSizeMinimum)

getBlockDistributionSizeMaximum

public Integer getBlockDistributionSizeMaximum()

setBlockDistributionSizeMaximum

public void setBlockDistributionSizeMaximum(Integer blockDistributionSizeMaximum)

getBlockDistributionSizeRatio

public Double getBlockDistributionSizeRatio()

setBlockDistributionSizeRatio

public void setBlockDistributionSizeRatio(Double blockDistributionSizeRatio)

getBlockDistributionUniformDistributionProbability

public Double getBlockDistributionUniformDistributionProbability()

setBlockDistributionUniformDistributionProbability

public void setBlockDistributionUniformDistributionProbability(Double blockDistributionUniformDistributionProbability)

getLinearDistributionSizeMaximum

public Integer getLinearDistributionSizeMaximum()

setLinearDistributionSizeMaximum

public void setLinearDistributionSizeMaximum(Integer linearDistributionSizeMaximum)

getParabolicDistributionSizeMaximum

public Integer getParabolicDistributionSizeMaximum()

setParabolicDistributionSizeMaximum

public void setParabolicDistributionSizeMaximum(Integer parabolicDistributionSizeMaximum)

getBetaDistributionAlpha

public Double getBetaDistributionAlpha()

setBetaDistributionAlpha

public void setBetaDistributionAlpha(Double betaDistributionAlpha)

getBetaDistributionBeta

public Double getBetaDistributionBeta()

setBetaDistributionBeta

public void setBetaDistributionBeta(Double betaDistributionBeta)

withOriginEntitySelectorConfig

public NearbySelectionConfig withOriginEntitySelectorConfig(EntitySelectorConfig originEntitySelectorConfig)

withOriginSubListSelectorConfig

public NearbySelectionConfig withOriginSubListSelectorConfig(SubListSelectorConfig originSubListSelectorConfig)

withOriginValueSelectorConfig

public NearbySelectionConfig withOriginValueSelectorConfig(ValueSelectorConfig originValueSelectorConfig)

withNearbyDistanceMeterClass

public NearbySelectionConfig withNearbyDistanceMeterClass(Class<? extends NearbyDistanceMeter> nearbyDistanceMeterClass)

withNearbySelectionDistributionType

public NearbySelectionConfig withNearbySelectionDistributionType(NearbySelectionDistributionType nearbySelectionDistributionType)

withBlockDistributionSizeMinimum

public NearbySelectionConfig withBlockDistributionSizeMinimum(Integer blockDistributionSizeMinimum)

withBlockDistributionSizeMaximum

public NearbySelectionConfig withBlockDistributionSizeMaximum(Integer blockDistributionSizeMaximum)

withBlockDistributionSizeRatio

public NearbySelectionConfig withBlockDistributionSizeRatio(Double blockDistributionSizeRatio)

withBlockDistributionUniformDistributionProbability

public NearbySelectionConfig withBlockDistributionUniformDistributionProbability(Double blockDistributionUniformDistributionProbability)

withLinearDistributionSizeMaximum

public NearbySelectionConfig withLinearDistributionSizeMaximum(Integer linearDistributionSizeMaximum)

withParabolicDistributionSizeMaximum

public NearbySelectionConfig withParabolicDistributionSizeMaximum(Integer parabolicDistributionSizeMaximum)

withBetaDistributionAlpha

public NearbySelectionConfig withBetaDistributionAlpha(Double betaDistributionAlpha)

withBetaDistributionBeta

public NearbySelectionConfig withBetaDistributionBeta(Double betaDistributionBeta)

validateNearby

public void validateNearby(SelectionCacheType resolvedCacheType,
                           SelectionOrder resolvedSelectionOrder)

inherit

public NearbySelectionConfig inherit(NearbySelectionConfig 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.

Specified by:

inherit in class AbstractConfig<NearbySelectionConfig>

Parameters:

inheritedConfig - never null

Returns:

this

copyConfig

public NearbySelectionConfig 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<NearbySelectionConfig>

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

Parameters:

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