Package ai.timefold.solver.core.impl.domain.solution

Interface ConstraintWeightSupplier<Solution_,Score_ extends Score<Score_>>

All Known Implementing Classes:

ConstraintConfigurationBasedConstraintWeightSupplier, OverridesBasedConstraintWeightSupplier

public sealed interface ConstraintWeightSupplier<Solution_,Score_ extends Score<Score_>>
permits OverridesBasedConstraintWeightSupplier<Score_,Solution_>, ConstraintConfigurationBasedConstraintWeightSupplier<Score_,Solution_>

Method Summary

Modifier and Type	Method	Description
Score_	getConstraintWeight(ConstraintRef constraintRef, Solution_ workingSolution)	Get the weight for the constraint if known to the supplier.
String	getDefaultConstraintPackage()
Class<?>	getProblemFactClass()	The class that carries the constraint weights.
void	initialize(SolutionDescriptor<Solution_> solutionDescriptor, MemberAccessorFactory memberAccessorFactory, DomainAccessType domainAccessType)
void	validate(Solution_ workingSolution, Set<ConstraintRef> userDefinedConstraints)	Will be called after initialize(SolutionDescriptor, MemberAccessorFactory, DomainAccessType).

Method Details

initialize

void initialize(SolutionDescriptor<Solution_> solutionDescriptor,
 MemberAccessorFactory memberAccessorFactory,
 DomainAccessType domainAccessType)

validate

void validate(Solution_ workingSolution,
 Set<ConstraintRef> userDefinedConstraints)

Will be called after initialize(SolutionDescriptor, MemberAccessorFactory, DomainAccessType). Has the option of failing fast in case of discrepancies between the constraints defined in ConstraintProvider and the constraints defined in the configuration.

Parameters:

userDefinedConstraints - never null

getProblemFactClass

Class<?> getProblemFactClass()

The class that carries the constraint weights. It will either be annotated by ConstraintConfiguration, or be ConstraintWeightOverrides.

Returns:

never null

getDefaultConstraintPackage

String getDefaultConstraintPackage()

getConstraintWeight

Score_ getConstraintWeight(ConstraintRef constraintRef,
 Solution_ workingSolution)

Get the weight for the constraint if known to the supplier. Supplies may choose not to provide a value for unknown constraints, which is the case for OverridesBasedConstraintWeightSupplier. ConstraintConfigurationBasedConstraintWeightSupplier will always provide a value.

Parameters:

constraintRef - never null

workingSolution - never null

Returns:

may be null, if the provider does not know the constraint