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

Interface InnerBiConstraintStream<A,B>

All Superinterfaces:

BiConstraintStream<A,B>, ConstraintStream

All Known Implementing Classes:

BavetAbstractBiConstraintStream, BavetAftBridgeBiConstraintStream, BavetBiConcatBiConstraintStream, BavetForeBridgeBiConstraintStream, BavetJoinBiConstraintStream, BavetUniConcatBiConstraintStream

public interface InnerBiConstraintStream<A,B>
extends BiConstraintStream<A,B>

Method Summary

Modifier and Type	Method	Description
static <A, B> BiFunction<A,B,Collection<?>>	createDefaultIndictedObjectsMapping()
static <A, B> TriFunction<A,B,Score<?>,DefaultConstraintJustification>	createDefaultJustificationMapping()
default @NonNull BiConstraintStream<A,B>	distinct()	Transforms the stream in such a way that all the tuples going through it are distinct.
RetrievalSemantics	getRetrievalSemantics()
boolean	guaranteesDistinct()	This method will return true if the constraint stream is guaranteed to only produce distinct tuples.
default <C> @NonNull BiConstraintStream<A,B>	ifExists(@NonNull Class<C> otherClass, TriJoiner<A,B,C> @NonNull ... joiners)	As defined by BiConstraintStream.ifExists(Class, TriJoiner).
default <C> @NonNull BiConstraintStream<A,B>	ifExistsIncludingUnassigned(@NonNull Class<C> otherClass, @NonNull TriJoiner<A,B,C> @NonNull ... joiners)	As defined by BiConstraintStream.ifExistsIncludingUnassigned(Class, TriJoiner).
default <C> @NonNull BiConstraintStream<A,B>	ifNotExists(@NonNull Class<C> otherClass, @NonNull TriJoiner<A,B,C>... joiners)	As defined by BiConstraintStream.ifNotExists(Class, TriJoiner).
default <C> @NonNull BiConstraintStream<A,B>	ifNotExistsIncludingUnassigned(@NonNull Class<C> otherClass, @NonNull TriJoiner<A,B,C>... joiners)	As defined by BiConstraintStream.ifNotExistsIncludingUnassigned(Class, TriJoiner).
default @NonNull Constraint	impact(@NonNull String constraintName, @NonNull Score<?> constraintWeight)	Positively or negatively impact the Score by the constraintWeight for each match.
default @NonNull Constraint	impact(@NonNull String constraintPackage, @NonNull String constraintName, @NonNull Score<?> constraintWeight)	As defined by ConstraintStream.impact(String, Score).
default <Score_ extends Score<Score_>> @NonNull BiConstraintBuilder<A,B,Score_>	impact(@NonNull Score_ constraintWeight, @NonNull ToIntBiFunction<A,B> 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_>> @NonNull BiConstraintBuilder<A,B,Score_>	impactBigDecimal(@NonNull Score_ constraintWeight, @NonNull BiFunction<A,B,BigDecimal> matchWeigher)	As defined by BiConstraintStream.impact(Score, ToIntBiFunction), with an impact of type BigDecimal.
default BiConstraintBuilder<A,B,?>	impactConfigurable(ToIntBiFunction<A,B> 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 BiConstraintBuilder<A,B,?>	impactConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)	As defined by BiConstraintStream.impactConfigurable(ToIntBiFunction), with an impact of type BigDecimal.
default BiConstraintBuilder<A,B,?>	impactConfigurableLong(ToLongBiFunction<A,B> matchWeigher)	As defined by BiConstraintStream.impactConfigurable(ToIntBiFunction), with an impact of type long.
default <Score_ extends Score<Score_>> @NonNull BiConstraintBuilder<A,B,Score_>	impactLong(@NonNull Score_ constraintWeight, @NonNull ToLongBiFunction<A,B> matchWeigher)	As defined by BiConstraintStream.impact(Score, ToIntBiFunction), with an impact of type long.
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	innerImpact(Score_ constraintWeight, BiFunction<A,B,BigDecimal> matchWeigher, ScoreImpactType scoreImpactType)
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	innerImpact(Score_ constraintWeight, ToIntBiFunction<A,B> matchWeigher, ScoreImpactType scoreImpactType)
<Score_ extends Score<Score_>> BiConstraintBuilder<A,B,Score_>	innerImpact(Score_ constraintWeight, ToLongBiFunction<A,B> matchWeigher, ScoreImpactType scoreImpactType)
default <C> @NonNull TriConstraintStream<A,B,C>	join(@NonNull Class<C> otherClass, TriJoiner<A,B,C>... joiners)	As defined by BiConstraintStream.join(Class, TriJoiner).
default @NonNull Constraint	penalize(@NonNull String constraintName, @NonNull Score<?> constraintWeight)	Negatively impact the Score: subtract the constraintWeight for each match.
default @NonNull Constraint	penalize(@NonNull String constraintPackage, @NonNull String constraintName, @NonNull Score<?> constraintWeight)	As defined by ConstraintStream.penalize(String, Score).
default <Score_ extends Score<Score_>> @NonNull BiConstraintBuilder<A,B,Score_>	penalize(@NonNull Score_ constraintWeight, @NonNull ToIntBiFunction<A,B> 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_>> @NonNull BiConstraintBuilder<A,B,Score_>	penalizeBigDecimal(@NonNull Score_ constraintWeight, @NonNull BiFunction<A,B,BigDecimal> matchWeigher)	As defined by BiConstraintStream.penalize(Score, ToIntBiFunction), with a penalty of type BigDecimal.
default @NonNull Constraint	penalizeConfigurable(@NonNull String constraintName)	Negatively impact the Score: subtract the ConstraintWeight for each match.
default @NonNull Constraint	penalizeConfigurable(@NonNull String constraintPackage, @NonNull String constraintName)	As defined by ConstraintStream.penalizeConfigurable(String).
default BiConstraintBuilder<A,B,?>	penalizeConfigurable(ToIntBiFunction<A,B> 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 BiConstraintBuilder<A,B,?>	penalizeConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)	As defined by BiConstraintStream.penalizeConfigurable(ToIntBiFunction), with a penalty of type BigDecimal.
default BiConstraintBuilder<A,B,?>	penalizeConfigurableLong(ToLongBiFunction<A,B> matchWeigher)	As defined by BiConstraintStream.penalizeConfigurable(ToIntBiFunction), with a penalty of type long.
default <Score_ extends Score<Score_>> @NonNull BiConstraintBuilder<A,B,Score_>	penalizeLong(@NonNull Score_ constraintWeight, @NonNull ToLongBiFunction<A,B> matchWeigher)	As defined by BiConstraintStream.penalize(Score, ToIntBiFunction), with a penalty of type long.
default @NonNull Constraint	reward(@NonNull String constraintName, @NonNull Score<?> constraintWeight)	Positively impact the Score: add the constraintWeight for each match.
default @NonNull Constraint	reward(@NonNull String constraintPackage, @NonNull String constraintName, @NonNull Score<?> constraintWeight)	As defined by ConstraintStream.reward(String, Score).
default <Score_ extends Score<Score_>> @NonNull BiConstraintBuilder<A,B,Score_>	reward(@NonNull Score_ constraintWeight, @NonNull ToIntBiFunction<A,B> 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_>> @NonNull BiConstraintBuilder<A,B,Score_>	rewardBigDecimal(@NonNull Score_ constraintWeight, @NonNull BiFunction<A,B,BigDecimal> matchWeigher)	As defined by BiConstraintStream.reward(Score, ToIntBiFunction), with a penalty of type BigDecimal.
default @NonNull Constraint	rewardConfigurable(@NonNull String constraintName)	Positively impact the Score: add the ConstraintWeight for each match.
default @NonNull Constraint	rewardConfigurable(@NonNull String constraintPackage, @NonNull String constraintName)	As defined by ConstraintStream.rewardConfigurable(String).
default BiConstraintBuilder<A,B,?>	rewardConfigurable(ToIntBiFunction<A,B> 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 BiConstraintBuilder<A,B,?>	rewardConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)	As defined by BiConstraintStream.rewardConfigurable(ToIntBiFunction), with a penalty of type BigDecimal.
default BiConstraintBuilder<A,B,?>	rewardConfigurableLong(ToLongBiFunction<A,B> matchWeigher)	As defined by BiConstraintStream.rewardConfigurable(ToIntBiFunction), with a penalty of type long.
default <Score_ extends Score<Score_>> @NonNull BiConstraintBuilder<A,B,Score_>	rewardLong(@NonNull Score_ constraintWeight, @NonNull ToLongBiFunction<A,B> matchWeigher)	As defined by BiConstraintStream.reward(Score, ToIntBiFunction), with a penalty of type long.

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

complement, complement, concat, concat, concat, concat, concat, concat, concat, expand, 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

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

getConstraintFactory

Method Details

createDefaultJustificationMapping

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

createDefaultIndictedObjectsMapping

static <A,
B> BiFunction<A,B,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 <C> @NonNull TriConstraintStream<A,B,C> join(@NonNull Class<C> otherClass,
 TriJoiner<A,B,C>... joiners)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.join(Class, TriJoiner). 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 BiJoiner parameters.

Specified by:

join in interface BiConstraintStream<A,B>

Type Parameters:

C - the type of the third matched fact

Returns:

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

ifExists

default <C> @NonNull BiConstraintStream<A,B> ifExists(@NonNull Class<C> otherClass,
 TriJoiner<A,B,C> @NonNull ... joiners)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.ifExists(Class, TriJoiner). 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 TriJoiner parameters.

Specified by:

ifExists in interface BiConstraintStream<A,B>

Type Parameters:

C - the type of the third matched fact

Returns:

a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifExistsIncludingUnassigned

default <C> @NonNull BiConstraintStream<A,B> ifExistsIncludingUnassigned(@NonNull Class<C> otherClass,
 @NonNull TriJoiner<A,B,C> @NonNull ... joiners)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.ifExistsIncludingUnassigned(Class, TriJoiner). 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 TriJoiner parameters.

Specified by:

ifExistsIncludingUnassigned in interface BiConstraintStream<A,B>

Type Parameters:

C - the type of the third matched fact

Returns:

a stream that matches every pair of A and B where C exists for which the TriJoiners are true

ifNotExists

default <C> @NonNull BiConstraintStream<A,B> ifNotExists(@NonNull Class<C> otherClass,
 @NonNull TriJoiner<A,B,C>... joiners)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.ifNotExists(Class, TriJoiner). 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 TriJoiner parameters.

Specified by:

ifNotExists in interface BiConstraintStream<A,B>

Type Parameters:

C - the type of the third matched fact

Returns:

a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

ifNotExistsIncludingUnassigned

default <C> @NonNull BiConstraintStream<A,B> ifNotExistsIncludingUnassigned(@NonNull Class<C> otherClass,
 @NonNull TriJoiner<A,B,C>... joiners)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.ifNotExistsIncludingUnassigned(Class, TriJoiner). 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 TriJoiner parameters.

Specified by:

ifNotExistsIncludingUnassigned in interface BiConstraintStream<A,B>

Type Parameters:

C - the type of the third matched fact

Returns:

a stream that matches every pair of A and B where C does not exist for which the TriJoiners are true

distinct

default @NonNull BiConstraintStream<A,B> distinct()

Description copied from interface: BiConstraintStream

Transforms the stream in such a way that all the tuples going through it are distinct. (No two result tuples are equal.)

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

Specified by:

distinct in interface BiConstraintStream<A,B>

penalize

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> penalize(@NonNull Score_ constraintWeight,
 @NonNull ToIntBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

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 BiConstraintStream.penalizeLong(Score, ToLongBiFunction) or BiConstraintStream.penalizeBigDecimal(Score, BiFunction) instead.

Specified by:

penalize in interface BiConstraintStream<A,B>

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

penalizeLong

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> penalizeLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.penalize(Score, ToIntBiFunction), with a penalty of type long.

Specified by:

penalizeLong in interface BiConstraintStream<A,B>

penalizeBigDecimal

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> penalizeBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull BiFunction<A,B,BigDecimal> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.penalize(Score, ToIntBiFunction), with a penalty of type BigDecimal.

Specified by:

penalizeBigDecimal in interface BiConstraintStream<A,B>

penalizeConfigurable

default BiConstraintBuilder<A,B,?> penalizeConfigurable(ToIntBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

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 BiConstraintStream<A,B>

Parameters:

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

Returns:

never null

penalizeConfigurableLong

default BiConstraintBuilder<A,B,?> penalizeConfigurableLong(ToLongBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.penalizeConfigurable(ToIntBiFunction), with a penalty of type long.

Specified by:

penalizeConfigurableLong in interface BiConstraintStream<A,B>

penalizeConfigurableBigDecimal

default BiConstraintBuilder<A,B,?> penalizeConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.penalizeConfigurable(ToIntBiFunction), with a penalty of type BigDecimal.

Specified by:

penalizeConfigurableBigDecimal in interface BiConstraintStream<A,B>

reward

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> reward(@NonNull Score_ constraintWeight,
 @NonNull ToIntBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

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 BiConstraintStream.rewardLong(Score, ToLongBiFunction) or BiConstraintStream.rewardBigDecimal(Score, BiFunction) instead.

Specified by:

reward in interface BiConstraintStream<A,B>

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

rewardLong

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> rewardLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.reward(Score, ToIntBiFunction), with a penalty of type long.

Specified by:

rewardLong in interface BiConstraintStream<A,B>

rewardBigDecimal

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> rewardBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull BiFunction<A,B,BigDecimal> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.reward(Score, ToIntBiFunction), with a penalty of type BigDecimal.

Specified by:

rewardBigDecimal in interface BiConstraintStream<A,B>

rewardConfigurable

default BiConstraintBuilder<A,B,?> rewardConfigurable(ToIntBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

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 BiConstraintStream<A,B>

Parameters:

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

Returns:

never null

rewardConfigurableLong

default BiConstraintBuilder<A,B,?> rewardConfigurableLong(ToLongBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.rewardConfigurable(ToIntBiFunction), with a penalty of type long.

Specified by:

rewardConfigurableLong in interface BiConstraintStream<A,B>

rewardConfigurableBigDecimal

default BiConstraintBuilder<A,B,?> rewardConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.rewardConfigurable(ToIntBiFunction), with a penalty of type BigDecimal.

Specified by:

rewardConfigurableBigDecimal in interface BiConstraintStream<A,B>

impact

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> impact(@NonNull Score_ constraintWeight,
 @NonNull ToIntBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

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 BiConstraintStream<A,B>

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

impactLong

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> impactLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.impact(Score, ToIntBiFunction), with an impact of type long.

Specified by:

impactLong in interface BiConstraintStream<A,B>

impactBigDecimal

default <Score_ extends Score<Score_>>
@NonNull BiConstraintBuilder<A,B,Score_> impactBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull BiFunction<A,B,BigDecimal> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.impact(Score, ToIntBiFunction), with an impact of type BigDecimal.

Specified by:

impactBigDecimal in interface BiConstraintStream<A,B>

impactConfigurable

default BiConstraintBuilder<A,B,?> impactConfigurable(ToIntBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

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 BiConstraintStream<A,B>

Returns:

never null

impactConfigurableLong

default BiConstraintBuilder<A,B,?> impactConfigurableLong(ToLongBiFunction<A,B> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.impactConfigurable(ToIntBiFunction), with an impact of type long.

Specified by:

impactConfigurableLong in interface BiConstraintStream<A,B>

impactConfigurableBigDecimal

default BiConstraintBuilder<A,B,?> impactConfigurableBigDecimal(BiFunction<A,B,BigDecimal> matchWeigher)

Description copied from interface: BiConstraintStream

As defined by BiConstraintStream.impactConfigurable(ToIntBiFunction), with an impact of type BigDecimal.

Specified by:

impactConfigurableBigDecimal in interface BiConstraintStream<A,B>

innerImpact

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> innerImpact(Score_ constraintWeight,
 ToIntBiFunction<A,B> matchWeigher,
 ScoreImpactType scoreImpactType)

innerImpact

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> innerImpact(Score_ constraintWeight,
 ToLongBiFunction<A,B> matchWeigher,
 ScoreImpactType scoreImpactType)

innerImpact

<Score_ extends Score<Score_>>
BiConstraintBuilder<A,B,Score_> innerImpact(Score_ constraintWeight,
 BiFunction<A,B,BigDecimal> matchWeigher,
 ScoreImpactType scoreImpactType)

penalize

default @NonNull Constraint penalize(@NonNull String constraintName,
 @NonNull 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 - shows up in ConstraintMatchTotal during score justification

penalize

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

Description copied from interface: ConstraintStream

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

Specified by:

penalize in interface ConstraintStream

penalizeConfigurable

default @NonNull Constraint penalizeConfigurable(@NonNull 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 - shows up in ConstraintMatchTotal during score justification

penalizeConfigurable

default @NonNull Constraint penalizeConfigurable(@NonNull String constraintPackage,
 @NonNull String constraintName)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.penalizeConfigurable(String).

Specified by:

penalizeConfigurable in interface ConstraintStream

reward

default @NonNull Constraint reward(@NonNull String constraintName,
 @NonNull 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 - shows up in ConstraintMatchTotal during score justification

reward

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

Description copied from interface: ConstraintStream

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

Specified by:

reward in interface ConstraintStream

rewardConfigurable

default @NonNull Constraint rewardConfigurable(@NonNull 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 - shows up in ConstraintMatchTotal during score justification

rewardConfigurable

default @NonNull Constraint rewardConfigurable(@NonNull String constraintPackage,
 @NonNull String constraintName)

Description copied from interface: ConstraintStream

As defined by ConstraintStream.rewardConfigurable(String).

Specified by:

rewardConfigurable in interface ConstraintStream

impact

default @NonNull Constraint impact(@NonNull String constraintName,
 @NonNull 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 - shows up in ConstraintMatchTotal during score justification

impact

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

Description copied from interface: ConstraintStream

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

Specified by:

impact in interface ConstraintStream