Package ai.timefold.solver.core.api.score.constraint

Interface ConstraintMatchTotal<Score_ extends Score<Score_>>

Type Parameters:

Score_ - the actual score type

All Known Implementing Classes:

DefaultConstraintMatchTotal

public interface ConstraintMatchTotal<Score_ extends Score<Score_>>

Explains the Score of a PlanningSolution, from the opposite side than Indictment. Retrievable from ScoreExplanation.getConstraintMatchTotalMap().

If possible, prefer using SolutionManager.analyze(Object) instead.

Method Summary

Modifier and Type	Method	Description
static String	composeConstraintId(String constraintPackage, String constraintName)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer ConstraintRef.of(String, String).
default String	getConstraintId()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer getConstraintRef().
default int	getConstraintMatchCount()
@NonNull Set<ConstraintMatch<Score_>>	getConstraintMatchSet()
default String	getConstraintName()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer getConstraintRef().
default String	getConstraintPackage()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer getConstraintRef().
@NonNull ConstraintRef	getConstraintRef()
@NonNull Score_	getConstraintWeight()	The effective value of constraint weight after applying optional overrides.
@NonNull Score_	getScore()	Sum of the getConstraintMatchSet()'s ConstraintMatch.getScore().

Method Details

composeConstraintId

@Deprecated(forRemoval=true,
            since="1.4.0")
static String composeConstraintId(String constraintPackage,
 String constraintName)

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer ConstraintRef.of(String, String).

Parameters:

constraintPackage - never null

constraintName - never null

Returns:

never null

getConstraintRef

@NonNull ConstraintRef getConstraintRef()

getConstraintPackage

@Deprecated(forRemoval=true,
            since="1.4.0")
default String getConstraintPackage()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer getConstraintRef().

Returns:

never null

getConstraintName

@Deprecated(forRemoval=true,
            since="1.4.0")
default String getConstraintName()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer getConstraintRef().

Returns:

never null

getConstraintWeight

@NonNull Score_ getConstraintWeight()

The effective value of constraint weight after applying optional overrides. It is independent to the state of the planning variables. Do not confuse with getScore().

getConstraintMatchSet

@NonNull Set<ConstraintMatch<Score_>> getConstraintMatchSet()

getConstraintMatchCount

default int getConstraintMatchCount()

Returns:

>= 0

getScore

@NonNull Score_ getScore()

Sum of the getConstraintMatchSet()'s ConstraintMatch.getScore().

getConstraintId

@Deprecated(forRemoval=true,
            since="1.4.0")
default String getConstraintId()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer getConstraintRef().

Returns:

never null