Package ai.timefold.solver.core.impl.score.stream.common.tri

Interface InnerTriConstraintStream<A,B,C>

All Superinterfaces:

ConstraintStream, TriConstraintStream<A,B,C>

All Known Implementing Classes:

BavetAbstractTriConstraintStream, BavetAftBridgeTriConstraintStream, BavetBiConcatTriConstraintStream, BavetForeBridgeTriConstraintStream, BavetJoinTriConstraintStream, BavetTriConcatTriConstraintStream, BavetUniConcatTriConstraintStream

public interface InnerTriConstraintStream<A,B,C>
extends TriConstraintStream<A,B,C>

Method Summary

Modifier and Type	Method	Description
static <A, B, C> TriFunction<A,B,C,Collection<?>>	createDefaultIndictedObjectsMapping()
static <A, B, C> QuadFunction<A,B,C,Score<?>,DefaultConstraintJustification>	createDefaultJustificationMapping()
default TriConstraintStream<A,B,C>	distinct()	Removes duplicate tuples from the stream, according to the tuple's facts equals/hashCode methods, such that only distinct tuples remain.
RetrievalSemantics	getRetrievalSemantics()
boolean	guaranteesDistinct()	This method will return true if the constraint stream is guaranteed to only produce distinct tuples.
default <D> TriConstraintStream<A,B,C>	ifExists(Class<D> otherClass, QuadJoiner<A,B,C,D>... joiners)	As defined by TriConstraintStream.ifExists(Class, QuadJoiner).
default <D> TriConstraintStream<A,B,C>	ifExistsIncludingUnassigned(Class<D> otherClass, QuadJoiner<A,B,C,D>... joiners)	As defined by TriConstraintStream.ifExistsIncludingUnassigned(Class, QuadJoiner).
default <D> TriConstraintStream<A,B,C>	ifNotExists(Class<D> otherClass, QuadJoiner<A,B,C,D>... joiners)	As defined by TriConstraintStream.ifNotExists(Class, QuadJoiner).
default <D> TriConstraintStream<A,B,C>	ifNotExistsIncludingUnassigned(Class<D> otherClass, QuadJoiner<A,B,C,D>... joiners)	As defined by TriConstraintStream.ifNotExistsIncludingUnassigned(Class, QuadJoiner).
default Constraint	impact(String constraintName, Score<?> constraintWeight)	Positively or negatively impact the Score by the constraintWeight for each match.
default Constraint	impact(String constraintPackage, String constraintName, Score<?> constraintWeight)	As defined by ConstraintStream.impact(String, Score).
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	impact(Score_ constraintWeight, ToIntTriFunction<A,B,C> matchWeigher)	Positively or negatively impacts the Score by constraintWeight multiplied by matchWeight for each match and returns a builder to apply optional constraint properties.
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	impactBigDecimal(Score_ constraintWeight, TriFunction<A,B,C,BigDecimal> matchWeigher)	As defined by TriConstraintStream.impact(Score, ToIntTriFunction), with an impact of type BigDecimal.
default TriConstraintBuilder<A,B,C,?>	impactConfigurable(ToIntTriFunction<A,B,C> matchWeigher)	Positively impacts the Score by the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.
default TriConstraintBuilder<A,B,C,?>	impactConfigurableBigDecimal(TriFunction<A,B,C,BigDecimal> matchWeigher)	As defined by TriConstraintStream.impactConfigurable(ToIntTriFunction), with an impact of type BigDecimal.
default TriConstraintBuilder<A,B,C,?>	impactConfigurableLong(ToLongTriFunction<A,B,C> matchWeigher)	As defined by TriConstraintStream.impactConfigurable(ToIntTriFunction), with an impact of type long.
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	impactLong(Score_ constraintWeight, ToLongTriFunction<A,B,C> matchWeigher)	As defined by TriConstraintStream.impact(Score, ToIntTriFunction), with an impact of type long.
<Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	innerImpact(Score_ constraintWeight, ToIntTriFunction<A,B,C> matchWeigher, ScoreImpactType scoreImpactType)
<Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	innerImpact(Score_ constraintWeight, ToLongTriFunction<A,B,C> matchWeigher, ScoreImpactType scoreImpactType)
<Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	innerImpact(Score_ constraintWeight, TriFunction<A,B,C,BigDecimal> matchWeigher, ScoreImpactType scoreImpactType)
default <D> QuadConstraintStream<A,B,C,D>	join(Class<D> otherClass, QuadJoiner<A,B,C,D>... joiners)	As defined by TriConstraintStream.join(Class, QuadJoiner).
default Constraint	penalize(String constraintName, Score<?> constraintWeight)	Negatively impact the Score: subtract the constraintWeight for each match.
default Constraint	penalize(String constraintPackage, String constraintName, Score<?> constraintWeight)	As defined by ConstraintStream.penalize(String, Score).
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	penalize(Score_ constraintWeight, ToIntTriFunction<A,B,C> matchWeigher)	Applies a negative Score impact, subtracting the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	penalizeBigDecimal(Score_ constraintWeight, TriFunction<A,B,C,BigDecimal> matchWeigher)	As defined by TriConstraintStream.penalize(Score, ToIntTriFunction), with a penalty of type BigDecimal.
default TriConstraintBuilder<A,B,C,?>	penalizeConfigurable(ToIntTriFunction<A,B,C> matchWeigher)	Negatively impacts the Score, subtracting the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.
default Constraint	penalizeConfigurable(String constraintName)	Negatively impact the Score: subtract the ConstraintWeight for each match.
default Constraint	penalizeConfigurable(String constraintPackage, String constraintName)	As defined by ConstraintStream.penalizeConfigurable(String).
default TriConstraintBuilder<A,B,C,?>	penalizeConfigurableBigDecimal(TriFunction<A,B,C,BigDecimal> matchWeigher)	As defined by TriConstraintStream.penalizeConfigurable(ToIntTriFunction), with a penalty of type BigDecimal.
default TriConstraintBuilder<A,B,C,?>	penalizeConfigurableLong(ToLongTriFunction<A,B,C> matchWeigher)	As defined by TriConstraintStream.penalizeConfigurable(ToIntTriFunction), with a penalty of type long.
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	penalizeLong(Score_ constraintWeight, ToLongTriFunction<A,B,C> matchWeigher)	As defined by TriConstraintStream.penalize(Score, ToIntTriFunction), with a penalty of type long.
default Constraint	reward(String constraintName, Score<?> constraintWeight)	Positively impact the Score: add the constraintWeight for each match.
default Constraint	reward(String constraintPackage, String constraintName, Score<?> constraintWeight)	As defined by ConstraintStream.reward(String, Score).
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	reward(Score_ constraintWeight, ToIntTriFunction<A,B,C> matchWeigher)	Applies a positive Score impact, adding the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	rewardBigDecimal(Score_ constraintWeight, TriFunction<A,B,C,BigDecimal> matchWeigher)	As defined by TriConstraintStream.reward(Score, ToIntTriFunction), with a penalty of type BigDecimal.
default TriConstraintBuilder<A,B,C,?>	rewardConfigurable(ToIntTriFunction<A,B,C> matchWeigher)	Positively impacts the Score, adding the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.
default Constraint	rewardConfigurable(String constraintName)	Positively impact the Score: add the ConstraintWeight for each match.
default Constraint	rewardConfigurable(String constraintPackage, String constraintName)	As defined by ConstraintStream.rewardConfigurable(String).
default TriConstraintBuilder<A,B,C,?>	rewardConfigurableBigDecimal(TriFunction<A,B,C,BigDecimal> matchWeigher)	As defined by TriConstraintStream.rewardConfigurable(ToIntTriFunction), with a penalty of type BigDecimal.
default TriConstraintBuilder<A,B,C,?>	rewardConfigurableLong(ToLongTriFunction<A,B,C> matchWeigher)	As defined by TriConstraintStream.rewardConfigurable(ToIntTriFunction), with a penalty of type long.
default <Score_ extends Score<Score_>> TriConstraintBuilder<A,B,C,Score_>	rewardLong(Score_ constraintWeight, ToLongTriFunction<A,B,C> matchWeigher)	As defined by TriConstraintStream.reward(Score, ToIntTriFunction), with a penalty of type long.

Methods inherited from interface ai.timefold.solver.core.api.score.stream.ConstraintStream

getConstraintFactory

Methods inherited from interface ai.timefold.solver.core.api.score.stream.tri.TriConstraintStream

complement, complement, concat, concat, concat, concat, concat, concat, concat, expand, filter, flattenLast, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, groupBy, ifExists, ifExists, ifExists, ifExists, ifExists, ifExists, ifExists, ifExists, ifExists, ifExistsIncludingNullVars, ifExistsIncludingNullVars, ifExistsIncludingNullVars, ifExistsIncludingNullVars, ifExistsIncludingNullVars, ifExistsIncludingUnassigned, ifExistsIncludingUnassigned, ifExistsIncludingUnassigned, ifExistsIncludingUnassigned, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingUnassigned, ifNotExistsIncludingUnassigned, ifNotExistsIncludingUnassigned, ifNotExistsIncludingUnassigned, impact, impact, impact, impactBigDecimal, impactBigDecimal, impactConfigurable, impactConfigurable, impactConfigurable, impactConfigurableBigDecimal, impactConfigurableBigDecimal, impactConfigurableLong, impactConfigurableLong, impactLong, impactLong, join, join, join, join, join, join, join, join, join, join, join, map, map, map, map, penalize, penalize, penalize, penalizeBigDecimal, penalizeBigDecimal, penalizeBigDecimal, penalizeConfigurable, penalizeConfigurable, penalizeConfigurable, penalizeConfigurableBigDecimal, penalizeConfigurableBigDecimal, penalizeConfigurableLong, penalizeConfigurableLong, penalizeLong, penalizeLong, penalizeLong, reward, reward, reward, rewardBigDecimal, rewardBigDecimal, rewardConfigurable, rewardConfigurable, rewardConfigurable, rewardConfigurableBigDecimal, rewardConfigurableBigDecimal, rewardConfigurableLong, rewardConfigurableLong, rewardLong, rewardLong

Method Details

createDefaultJustificationMapping

static <A,
B,
C>
QuadFunction<A,B,C,Score<?>,DefaultConstraintJustification> createDefaultJustificationMapping()

createDefaultIndictedObjectsMapping

static <A,
B,
C> TriFunction<A,B,C,Collection<?>> createDefaultIndictedObjectsMapping()

getRetrievalSemantics

RetrievalSemantics getRetrievalSemantics()

guaranteesDistinct

boolean guaranteesDistinct()

This method will return true if the constraint stream is guaranteed to only produce distinct tuples. See distinct() for details.

Returns:

true if the guarantee of distinct tuples is provided

join

default <D> QuadConstraintStream<A,B,C,D> join(Class<D> otherClass,
 QuadJoiner<A,B,C,D>... joiners)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.join(Class, QuadJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 QuadJoiner parameters.

Specified by:

join in interface TriConstraintStream<A,B,C>

Type Parameters:

D - the type of the fourth matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every combination of [A, B, C] and D for which all the joiners are true

ifExists

default <D> TriConstraintStream<A,B,C> ifExists(Class<D> otherClass,
 QuadJoiner<A,B,C,D>... joiners)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.ifExists(Class, QuadJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 QuadJoiner parameters.

Specified by:

ifExists in interface TriConstraintStream<A,B,C>

Type Parameters:

D - the type of the fourth matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every tuple of A, B and C where D exists for which the QuadJoiners are true

ifExistsIncludingUnassigned

default <D> TriConstraintStream<A,B,C> ifExistsIncludingUnassigned(Class<D> otherClass,
 QuadJoiner<A,B,C,D>... joiners)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.ifExistsIncludingUnassigned(Class, QuadJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 QuadJoiner parameters.

Specified by:

ifExistsIncludingUnassigned in interface TriConstraintStream<A,B,C>

Type Parameters:

D - the type of the fourth matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every tuple of A, B and C where D exists for which the QuadJoiners are true

ifNotExists

default <D> TriConstraintStream<A,B,C> ifNotExists(Class<D> otherClass,
 QuadJoiner<A,B,C,D>... joiners)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.ifNotExists(Class, QuadJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 QuadJoiner parameters.

Specified by:

ifNotExists in interface TriConstraintStream<A,B,C>

Type Parameters:

D - the type of the fourth matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every tuple of A, B and C where D does not exist for which the QuadJoiners are true

ifNotExistsIncludingUnassigned

default <D> TriConstraintStream<A,B,C> ifNotExistsIncludingUnassigned(Class<D> otherClass,
 QuadJoiner<A,B,C,D>... joiners)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.ifNotExistsIncludingUnassigned(Class, QuadJoiner). For performance reasons, indexing joiners must be placed before filtering joiners.

This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 QuadJoiner parameters.

Specified by:

ifNotExistsIncludingUnassigned in interface TriConstraintStream<A,B,C>

Type Parameters:

D - the type of the fourth matched fact

Parameters:

otherClass - never null

joiners - never null

Returns:

never null, a stream that matches every tuple of A, B and C where D does not exist for which the QuadJoiners are true

distinct

default TriConstraintStream<A,B,C> distinct()

Description copied from interface: TriConstraintStream

Removes duplicate tuples from the stream, according to the tuple's facts equals/hashCode methods, such that only distinct tuples remain. (No two tuples will equal.)

By default, tuples going through a constraint stream are distinct. However, operations such as TriConstraintStream.map(TriFunction) may create a stream which breaks that promise. By calling this method on such a stream, duplicate copies of the same tuple will be omitted at a performance cost.

Specified by:

distinct in interface TriConstraintStream<A,B,C>

Returns:

never null

penalize

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> penalize(Score_ constraintWeight,
 ToIntTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

Applies a negative Score impact, subtracting the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.

The constraintWeight specified here can be overridden using ConstraintWeightOverrides on the PlanningSolution-annotated class

For non-int Score types use TriConstraintStream.penalizeLong(Score, ToLongTriFunction) or TriConstraintStream.penalizeBigDecimal(Score, TriFunction) instead.

Specified by:

penalize in interface TriConstraintStream<A,B,C>

Parameters:

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeLong

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> penalizeLong(Score_ constraintWeight,
 ToLongTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.penalize(Score, ToIntTriFunction), with a penalty of type long.

Specified by:

penalizeLong in interface TriConstraintStream<A,B,C>

penalizeBigDecimal

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> penalizeBigDecimal(Score_ constraintWeight,
 TriFunction<A,B,C,BigDecimal> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.penalize(Score, ToIntTriFunction), with a penalty of type BigDecimal.

Specified by:

penalizeBigDecimal in interface TriConstraintStream<A,B,C>

penalizeConfigurable

default TriConstraintBuilder<A,B,C,?> penalizeConfigurable(ToIntTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

Negatively impacts the Score, subtracting the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Specified by:

penalizeConfigurable in interface TriConstraintStream<A,B,C>

Parameters:

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

penalizeConfigurableLong

default TriConstraintBuilder<A,B,C,?> penalizeConfigurableLong(ToLongTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.penalizeConfigurable(ToIntTriFunction), with a penalty of type long.

Specified by:

penalizeConfigurableLong in interface TriConstraintStream<A,B,C>

penalizeConfigurableBigDecimal

default TriConstraintBuilder<A,B,C,?> penalizeConfigurableBigDecimal(TriFunction<A,B,C,BigDecimal> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.penalizeConfigurable(ToIntTriFunction), with a penalty of type BigDecimal.

Specified by:

penalizeConfigurableBigDecimal in interface TriConstraintStream<A,B,C>

reward

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> reward(Score_ constraintWeight,
 ToIntTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

Applies a positive Score impact, adding the constraintWeight multiplied by the match weight, and returns a builder to apply optional constraint properties.

The constraintWeight specified here can be overridden using ConstraintWeightOverrides on the PlanningSolution-annotated class

For non-int Score types use TriConstraintStream.rewardLong(Score, ToLongTriFunction) or TriConstraintStream.rewardBigDecimal(Score, TriFunction) instead.

Specified by:

reward in interface TriConstraintStream<A,B,C>

Parameters:

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardLong

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> rewardLong(Score_ constraintWeight,
 ToLongTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.reward(Score, ToIntTriFunction), with a penalty of type long.

Specified by:

rewardLong in interface TriConstraintStream<A,B,C>

rewardBigDecimal

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> rewardBigDecimal(Score_ constraintWeight,
 TriFunction<A,B,C,BigDecimal> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.reward(Score, ToIntTriFunction), with a penalty of type BigDecimal.

Specified by:

rewardBigDecimal in interface TriConstraintStream<A,B,C>

rewardConfigurable

default TriConstraintBuilder<A,B,C,?> rewardConfigurable(ToIntTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

Positively impacts the Score, adding the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Specified by:

rewardConfigurable in interface TriConstraintStream<A,B,C>

Parameters:

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

rewardConfigurableLong

default TriConstraintBuilder<A,B,C,?> rewardConfigurableLong(ToLongTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.rewardConfigurable(ToIntTriFunction), with a penalty of type long.

Specified by:

rewardConfigurableLong in interface TriConstraintStream<A,B,C>

rewardConfigurableBigDecimal

default TriConstraintBuilder<A,B,C,?> rewardConfigurableBigDecimal(TriFunction<A,B,C,BigDecimal> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.rewardConfigurable(ToIntTriFunction), with a penalty of type BigDecimal.

Specified by:

rewardConfigurableBigDecimal in interface TriConstraintStream<A,B,C>

impact

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> impact(Score_ constraintWeight,
 ToIntTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

Positively or negatively impacts the Score by constraintWeight multiplied by matchWeight for each match and returns a builder to apply optional constraint properties.

The constraintWeight specified here can be overridden using ConstraintWeightOverrides on the PlanningSolution-annotated class

Use penalize(...) or reward(...) instead, unless this constraint can both have positive and negative weights.

Specified by:

impact in interface TriConstraintStream<A,B,C>

Parameters:

constraintWeight - never null

matchWeigher - never null, the result of this function (matchWeight) is multiplied by the constraintWeight

Returns:

never null

impactLong

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> impactLong(Score_ constraintWeight,
 ToLongTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.impact(Score, ToIntTriFunction), with an impact of type long.

Specified by:

impactLong in interface TriConstraintStream<A,B,C>

impactBigDecimal

default <Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> impactBigDecimal(Score_ constraintWeight,
 TriFunction<A,B,C,BigDecimal> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.impact(Score, ToIntTriFunction), with an impact of type BigDecimal.

Specified by:

impactBigDecimal in interface TriConstraintStream<A,B,C>

impactConfigurable

default TriConstraintBuilder<A,B,C,?> impactConfigurable(ToIntTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

Positively impacts the Score by the ConstraintWeight multiplied by match weight for each match, and returns a builder to apply optional constraint properties.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

Specified by:

impactConfigurable in interface TriConstraintStream<A,B,C>

Returns:

never null

impactConfigurableLong

default TriConstraintBuilder<A,B,C,?> impactConfigurableLong(ToLongTriFunction<A,B,C> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.impactConfigurable(ToIntTriFunction), with an impact of type long.

Specified by:

impactConfigurableLong in interface TriConstraintStream<A,B,C>

impactConfigurableBigDecimal

default TriConstraintBuilder<A,B,C,?> impactConfigurableBigDecimal(TriFunction<A,B,C,BigDecimal> matchWeigher)

Description copied from interface: TriConstraintStream

As defined by TriConstraintStream.impactConfigurable(ToIntTriFunction), with an impact of type BigDecimal.

Specified by:

impactConfigurableBigDecimal in interface TriConstraintStream<A,B,C>

innerImpact

<Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> innerImpact(Score_ constraintWeight,
 ToIntTriFunction<A,B,C> matchWeigher,
 ScoreImpactType scoreImpactType)

innerImpact

<Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> innerImpact(Score_ constraintWeight,
 ToLongTriFunction<A,B,C> matchWeigher,
 ScoreImpactType scoreImpactType)

innerImpact

<Score_ extends Score<Score_>>
TriConstraintBuilder<A,B,C,Score_> innerImpact(Score_ constraintWeight,
 TriFunction<A,B,C,BigDecimal> matchWeigher,
 ScoreImpactType scoreImpactType)

penalize

default Constraint penalize(String constraintName,
 Score<?> constraintWeight)

Description copied from interface: ConstraintStream

Negatively impact the Score: subtract the constraintWeight for each match.

To avoid hard-coding the constraintWeight, to allow end-users to tweak it, use ConstraintStream.penalizeConfigurable(String) and a ConstraintConfiguration instead.

The constraint package defaults to the package of the PlanningSolution class.

Specified by:

penalize in interface ConstraintStream

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

Returns:

never null

penalize

default Constraint penalize(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.penalize(String, Score).

Specified by:

penalize in interface ConstraintStream

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

Returns:

never null

penalizeConfigurable

default Constraint penalizeConfigurable(String constraintName)

Description copied from interface: ConstraintStream

Negatively impact the Score: subtract the ConstraintWeight for each match.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

The constraint package defaults to ConstraintConfiguration.constraintPackage().

Specified by:

penalizeConfigurable in interface ConstraintStream

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

Returns:

never null

penalizeConfigurable

default Constraint penalizeConfigurable(String constraintPackage,
 String constraintName)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.penalizeConfigurable(String).

Specified by:

penalizeConfigurable in interface ConstraintStream

Parameters:

constraintPackage - never null

constraintName - never null

Returns:

never null

reward

default Constraint reward(String constraintName,
 Score<?> constraintWeight)

Description copied from interface: ConstraintStream

Positively impact the Score: add the constraintWeight for each match.

To avoid hard-coding the constraintWeight, to allow end-users to tweak it, use ConstraintStream.penalizeConfigurable(String) and a ConstraintConfiguration instead.

The constraint package defaults to the package of the PlanningSolution class.

Specified by:

reward in interface ConstraintStream

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

Returns:

never null

reward

default Constraint reward(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.reward(String, Score).

Specified by:

reward in interface ConstraintStream

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

Returns:

never null

rewardConfigurable

default Constraint rewardConfigurable(String constraintName)

Description copied from interface: ConstraintStream

Positively impact the Score: add the ConstraintWeight for each match.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint may be deactivated if the ConstraintWeight is zero.

The constraint package defaults to ConstraintConfiguration.constraintPackage().

Specified by:

rewardConfigurable in interface ConstraintStream

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

Returns:

never null

rewardConfigurable

default Constraint rewardConfigurable(String constraintPackage,
 String constraintName)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.rewardConfigurable(String).

Specified by:

rewardConfigurable in interface ConstraintStream

Parameters:

constraintPackage - never null

constraintName - never null

Returns:

never null

impact

default Constraint impact(String constraintName,
 Score<?> constraintWeight)

Description copied from interface: ConstraintStream

Positively or negatively impact the Score by the constraintWeight for each match.

Use penalize(...) or reward(...) instead, unless this constraint can both have positive and negative weights.

The constraint package defaults to the package of the PlanningSolution class.

Specified by:

impact in interface ConstraintStream

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

Returns:

never null

impact

default Constraint impact(String constraintPackage,
 String constraintName,
 Score<?> constraintWeight)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.impact(String, Score).

Specified by:

impact in interface ConstraintStream

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

Returns:

never null