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

Class DefaultConstraintMatchTotal<Score_ extends Score<Score_>>

java.lang.Object

ai.timefold.solver.core.impl.score.constraint.DefaultConstraintMatchTotal<Score_>

Type Parameters:

Score_ -

All Implemented Interfaces:

ConstraintMatchTotal<Score_>, Comparable<DefaultConstraintMatchTotal<Score_>>

public final class DefaultConstraintMatchTotal<Score_ extends Score<Score_>>
extends Object
implements ConstraintMatchTotal<Score_>, Comparable<DefaultConstraintMatchTotal<Score_>>

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

Constructor Summary

Constructors

Constructor	Description
DefaultConstraintMatchTotal(ConstraintRef constraintRef)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).
DefaultConstraintMatchTotal(ConstraintRef constraintRef, Score_ constraintWeight)
DefaultConstraintMatchTotal(Constraint constraint, Score_ constraintWeight)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).
DefaultConstraintMatchTotal(String constraintPackage, String constraintName)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).
DefaultConstraintMatchTotal(String constraintPackage, String constraintName, Score_ constraintWeight)	Deprecated, for removal: This API element is subject to removal in a future version. Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).

Method Summary

Modifier and Type	Method	Description
void	addConstraintMatch(ConstraintMatch<Score_> constraintMatch)
ConstraintMatch<Score_>	addConstraintMatch(ConstraintJustification justification, Collection<Object> indictedObjects, Score_ score)	Creates a ConstraintMatch and adds it to the collection returned by getConstraintMatchSet().
ConstraintMatch<Score_>	addConstraintMatch(List<Object> justifications, Score_ score)	Creates a ConstraintMatch and adds it to the collection returned by getConstraintMatchSet().
int	compareTo(DefaultConstraintMatchTotal<Score_> other)
boolean	equals(Object o)
@NonNull Set<ConstraintMatch<Score_>>	getConstraintMatchSet()
@NonNull ConstraintRef	getConstraintRef()
@NonNull Score_	getConstraintWeight()	The effective value of constraint weight after applying optional overrides.
@NonNull Score_	getScore()	Sum of the ConstraintMatchTotal.getConstraintMatchSet()'s ConstraintMatch.getScore().
int	hashCode()
void	removeConstraintMatch(ConstraintMatch<Score_> constraintMatch)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.timefold.solver.core.api.score.constraint.ConstraintMatchTotal

getConstraintId, getConstraintMatchCount, getConstraintName, getConstraintPackage

Constructor Details

DefaultConstraintMatchTotal

@Deprecated(forRemoval=true,
            since="1.4.0")
public DefaultConstraintMatchTotal(String constraintPackage,
 String constraintName)

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

Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).

DefaultConstraintMatchTotal

@Deprecated(forRemoval=true,
            since="1.5.0")
public DefaultConstraintMatchTotal(ConstraintRef constraintRef)

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

Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).

DefaultConstraintMatchTotal

@Deprecated(forRemoval=true,
            since="1.4.0")
public DefaultConstraintMatchTotal(Constraint constraint,
 Score_ constraintWeight)

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

Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).

DefaultConstraintMatchTotal

@Deprecated(forRemoval=true,
            since="1.4.0")
public DefaultConstraintMatchTotal(String constraintPackage,
 String constraintName,
 Score_ constraintWeight)

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

Prefer DefaultConstraintMatchTotal(ConstraintRef, Score_).

DefaultConstraintMatchTotal

public DefaultConstraintMatchTotal(ConstraintRef constraintRef,
 Score_ constraintWeight)

Method Details

getConstraintRef

public @NonNull ConstraintRef getConstraintRef()

Specified by:

getConstraintRef in interface ConstraintMatchTotal<Score_ extends Score<Score_>>

getConstraintWeight

public @NonNull Score_ getConstraintWeight()

Description copied from interface: ConstraintMatchTotal

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

Specified by:

getConstraintWeight in interface ConstraintMatchTotal<Score_ extends Score<Score_>>

getConstraintMatchSet

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

Specified by:

getConstraintMatchSet in interface ConstraintMatchTotal<Score_ extends Score<Score_>>

getScore

public @NonNull Score_ getScore()

Description copied from interface: ConstraintMatchTotal

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

Specified by:

getScore in interface ConstraintMatchTotal<Score_ extends Score<Score_>>

addConstraintMatch

public ConstraintMatch<Score_> addConstraintMatch(List<Object> justifications,
 Score_ score)

Creates a ConstraintMatch and adds it to the collection returned by getConstraintMatchSet(). It will use DefaultConstraintJustification, whose DefaultConstraintJustification.getFacts() method will return the given list of justifications. Additionally, the constraint match will indict the objects in the given list of justifications.

Parameters:

justifications - never null, never empty

score - never null

Returns:

never null

addConstraintMatch

public ConstraintMatch<Score_> addConstraintMatch(ConstraintJustification justification,
 Collection<Object> indictedObjects,
 Score_ score)

Creates a ConstraintMatch and adds it to the collection returned by getConstraintMatchSet(). It will be justified with the provided ConstraintJustification. Additionally, the constraint match will indict the objects in the given list of indicted objects.

Parameters:

indictedObjects - never null, may be empty

score - never null

Returns:

never null

addConstraintMatch

public void addConstraintMatch(ConstraintMatch<Score_> constraintMatch)

removeConstraintMatch

public void removeConstraintMatch(ConstraintMatch<Score_> constraintMatch)

compareTo

public int compareTo(DefaultConstraintMatchTotal<Score_> other)

Specified by:

compareTo in interface Comparable<Score_ extends Score<Score_>>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object