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

Interface InnerUniConstraintStream<A>

All Superinterfaces:

ConstraintStream, UniConstraintStream<A>

All Known Implementing Classes:

BavetAbstractUniConstraintStream, BavetAftBridgeUniConstraintStream, BavetForEachUniConstraintStream, BavetForeBridgeUniConstraintStream, BavetUniConcatUniConstraintStream

public interface InnerUniConstraintStream<A>
extends UniConstraintStream<A>

Method Summary

Modifier and Type	Method	Description
static <A> Function<A,Collection<?>>	createDefaultIndictedObjectsMapping()
static <A> BiFunction<A,Score<?>,DefaultConstraintJustification>	createDefaultJustificationMapping()
default @NonNull UniConstraintStream<A>	distinct()	Transforms the stream in such a way that all the tuples going through it are distinct.
RetrievalSemantics	getRetrievalSemantics()
boolean	guaranteesDistinct()	This method returns true if the constraint stream is guaranteed to only produce distinct tuples.
default <B> @NonNull UniConstraintStream<A>	ifExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by UniConstraintStream.ifExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by UniConstraintStream.ifExistsIncludingUnassigned(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExists(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by UniConstraintStream.ifNotExists(Class, BiJoiner).
default <B> @NonNull UniConstraintStream<A>	ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by UniConstraintStream.ifNotExistsIncludingUnassigned(Class, BiJoiner).
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 UniConstraintBuilder<A,Score_>	impact(@NonNull Score_ constraintWeight, @NonNull ToIntFunction<A> 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 UniConstraintBuilder<A,Score_>	impactBigDecimal(@NonNull Score_ constraintWeight, @NonNull Function<A,BigDecimal> matchWeigher)	As defined by UniConstraintStream.impact(Score, ToIntFunction), with an impact of type BigDecimal.
default UniConstraintBuilder<A,?>	impactConfigurable(ToIntFunction<A> 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 UniConstraintBuilder<A,?>	impactConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)	As defined by UniConstraintStream.impactConfigurable(ToIntFunction), with an impact of type BigDecimal.
default UniConstraintBuilder<A,?>	impactConfigurableLong(ToLongFunction<A> matchWeigher)	As defined by UniConstraintStream.impactConfigurable(ToIntFunction), with an impact of type long.
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	impactLong(@NonNull Score_ constraintWeight, @NonNull ToLongFunction<A> matchWeigher)	As defined by UniConstraintStream.impact(Score, ToIntFunction), with an impact of type long.
<Score_ extends Score<Score_>> UniConstraintBuilder<A,Score_>	innerImpact(Score_ constraintWeight, Function<A,BigDecimal> matchWeigher, ScoreImpactType scoreImpactType)
<Score_ extends Score<Score_>> UniConstraintBuilder<A,Score_>	innerImpact(Score_ constraintWeight, ToIntFunction<A> matchWeigher, ScoreImpactType scoreImpactType)
<Score_ extends Score<Score_>> UniConstraintBuilder<A,Score_>	innerImpact(Score_ constraintWeight, ToLongFunction<A> matchWeigher, ScoreImpactType scoreImpactType)
default <B> @NonNull BiConstraintStream<A,B>	join(@NonNull Class<B> otherClass, @NonNull BiJoiner<A,B>... joiners)	As defined by UniConstraintStream.join(Class, BiJoiner).
<B> BiConstraintStream<A,B>	join(UniConstraintStream<B> otherStream, BiJoinerComber<A,B> joinerComber)	Allows ConstraintFactory.forEachUniquePair(Class) to reuse the joiner combing logic.
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 UniConstraintBuilder<A,Score_>	penalize(@NonNull Score_ constraintWeight, @NonNull ToIntFunction<A> 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 UniConstraintBuilder<A,Score_>	penalizeBigDecimal(@NonNull Score_ constraintWeight, @NonNull Function<A,BigDecimal> matchWeigher)	As defined by UniConstraintStream.penalize(Score, ToIntFunction), 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 UniConstraintBuilder<A,?>	penalizeConfigurable(ToIntFunction<A> 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 UniConstraintBuilder<A,?>	penalizeConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)	As defined by UniConstraintStream.penalizeConfigurable(ToIntFunction), with a penalty of type BigDecimal.
default UniConstraintBuilder<A,?>	penalizeConfigurableLong(ToLongFunction<A> matchWeigher)	As defined by UniConstraintStream.penalizeConfigurable(ToIntFunction), with a penalty of type long.
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	penalizeLong(@NonNull Score_ constraintWeight, @NonNull ToLongFunction<A> matchWeigher)	As defined by UniConstraintStream.penalize(Score, ToIntFunction), 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 UniConstraintBuilder<A,Score_>	reward(@NonNull Score_ constraintWeight, @NonNull ToIntFunction<A> 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 UniConstraintBuilder<A,Score_>	rewardBigDecimal(@NonNull Score_ constraintWeight, @NonNull Function<A,BigDecimal> matchWeigher)	As defined by UniConstraintStream.reward(Score, ToIntFunction), 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 UniConstraintBuilder<A,?>	rewardConfigurable(ToIntFunction<A> 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 UniConstraintBuilder<A,?>	rewardConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)	As defined by UniConstraintStream.rewardConfigurable(ToIntFunction), with a penalty of type BigDecimal.
default UniConstraintBuilder<A,?>	rewardConfigurableLong(ToLongFunction<A> matchWeigher)	As defined by UniConstraintStream.rewardConfigurable(ToIntFunction), with a penalty of type long.
default <Score_ extends Score<Score_>> @NonNull UniConstraintBuilder<A,Score_>	rewardLong(@NonNull Score_ constraintWeight, @NonNull ToLongFunction<A> matchWeigher)	As defined by UniConstraintStream.reward(Score, ToIntFunction), 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.uni.UniConstraintStream

complement, concat, concat, concat, concat, concat, concat, concat, expand, 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, ifExistsOther, ifExistsOther, ifExistsOther, ifExistsOther, ifExistsOther, ifExistsOther, ifExistsOtherIncludingNullVars, ifExistsOtherIncludingNullVars, ifExistsOtherIncludingNullVars, ifExistsOtherIncludingNullVars, ifExistsOtherIncludingNullVars, ifExistsOtherIncludingNullVars, ifExistsOtherIncludingUnassigned, ifExistsOtherIncludingUnassigned, ifExistsOtherIncludingUnassigned, ifExistsOtherIncludingUnassigned, ifExistsOtherIncludingUnassigned, ifExistsOtherIncludingUnassigned, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExists, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingNullVars, ifNotExistsIncludingUnassigned, ifNotExistsIncludingUnassigned, ifNotExistsIncludingUnassigned, ifNotExistsIncludingUnassigned, ifNotExistsOther, ifNotExistsOther, ifNotExistsOther, ifNotExistsOther, ifNotExistsOther, ifNotExistsOther, ifNotExistsOtherIncludingNullVars, ifNotExistsOtherIncludingNullVars, ifNotExistsOtherIncludingNullVars, ifNotExistsOtherIncludingNullVars, ifNotExistsOtherIncludingNullVars, ifNotExistsOtherIncludingNullVars, ifNotExistsOtherIncludingUnassigned, ifNotExistsOtherIncludingUnassigned, ifNotExistsOtherIncludingUnassigned, ifNotExistsOtherIncludingUnassigned, ifNotExistsOtherIncludingUnassigned, ifNotExistsOtherIncludingUnassigned, 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>
BiFunction<A,Score<?>,DefaultConstraintJustification> createDefaultJustificationMapping()

createDefaultIndictedObjectsMapping

static <A> Function<A,Collection<?>> createDefaultIndictedObjectsMapping()

getRetrievalSemantics

RetrievalSemantics getRetrievalSemantics()

guaranteesDistinct

boolean guaranteesDistinct()

This method returns 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 <B> @NonNull BiConstraintStream<A,B> join(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.join(Class, BiJoiner). For performance reasons, the 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 UniConstraintStream<A>

Type Parameters:

B - the type of the second matched fact

Returns:

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

join

<B> BiConstraintStream<A,B> join(UniConstraintStream<B> otherStream,
 BiJoinerComber<A,B> joinerComber)

Allows ConstraintFactory.forEachUniquePair(Class) to reuse the joiner combing logic.

Type Parameters:

B -

Parameters:

otherStream - never null

joinerComber - never null

Returns:

never null

ifExists

default <B> @NonNull UniConstraintStream<A> ifExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.ifExists(Class, BiJoiner). 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:

ifExists in interface UniConstraintStream<A>

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.ifExistsIncludingUnassigned(Class, BiJoiner). 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:

ifExistsIncludingUnassigned in interface UniConstraintStream<A>

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B exists for which all the BiJoiners are true

ifNotExists

default <B> @NonNull UniConstraintStream<A> ifNotExists(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.ifNotExists(Class, BiJoiner). 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:

ifNotExists in interface UniConstraintStream<A>

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

ifNotExistsIncludingUnassigned

default <B> @NonNull UniConstraintStream<A> ifNotExistsIncludingUnassigned(@NonNull Class<B> otherClass,
 @NonNull BiJoiner<A,B>... joiners)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.ifNotExistsIncludingUnassigned(Class, BiJoiner). 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:

ifNotExistsIncludingUnassigned in interface UniConstraintStream<A>

Type Parameters:

B - the type of the second matched fact

Returns:

a stream that matches every A where B does not exist for which all the BiJoiners are true

distinct

default @NonNull UniConstraintStream<A> distinct()

Description copied from interface: UniConstraintStream

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

By default, tuples going through a constraint stream are distinct. However, operations such as UniConstraintStream.map(Function) 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 UniConstraintStream<A>

penalize

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalize(@NonNull Score_ constraintWeight,
 @NonNull ToIntFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

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 UniConstraintStream.penalizeLong(Score, ToLongFunction) or UniConstraintStream.penalizeBigDecimal(Score, Function) instead.

Specified by:

penalize in interface UniConstraintStream<A>

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

penalizeLong

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalizeLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.penalize(Score, ToIntFunction), with a penalty of type long.

Specified by:

penalizeLong in interface UniConstraintStream<A>

penalizeBigDecimal

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> penalizeBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull Function<A,BigDecimal> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.penalize(Score, ToIntFunction), with a penalty of type BigDecimal.

Specified by:

penalizeBigDecimal in interface UniConstraintStream<A>

penalizeConfigurable

default UniConstraintBuilder<A,?> penalizeConfigurable(ToIntFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

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 UniConstraintStream<A>

Parameters:

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

Returns:

never null

penalizeConfigurableLong

default UniConstraintBuilder<A,?> penalizeConfigurableLong(ToLongFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.penalizeConfigurable(ToIntFunction), with a penalty of type long.

Specified by:

penalizeConfigurableLong in interface UniConstraintStream<A>

penalizeConfigurableBigDecimal

default UniConstraintBuilder<A,?> penalizeConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.penalizeConfigurable(ToIntFunction), with a penalty of type BigDecimal.

Specified by:

penalizeConfigurableBigDecimal in interface UniConstraintStream<A>

reward

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> reward(@NonNull Score_ constraintWeight,
 @NonNull ToIntFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

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 UniConstraintStream.rewardLong(Score, ToLongFunction) or UniConstraintStream.rewardBigDecimal(Score, Function) instead.

Specified by:

reward in interface UniConstraintStream<A>

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

rewardLong

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> rewardLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.reward(Score, ToIntFunction), with a penalty of type long.

Specified by:

rewardLong in interface UniConstraintStream<A>

rewardBigDecimal

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> rewardBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull Function<A,BigDecimal> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.reward(Score, ToIntFunction), with a penalty of type BigDecimal.

Specified by:

rewardBigDecimal in interface UniConstraintStream<A>

rewardConfigurable

default UniConstraintBuilder<A,?> rewardConfigurable(ToIntFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

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 UniConstraintStream<A>

Parameters:

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

Returns:

never null

rewardConfigurableLong

default UniConstraintBuilder<A,?> rewardConfigurableLong(ToLongFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.rewardConfigurable(ToIntFunction), with a penalty of type long.

Specified by:

rewardConfigurableLong in interface UniConstraintStream<A>

rewardConfigurableBigDecimal

default UniConstraintBuilder<A,?> rewardConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.rewardConfigurable(ToIntFunction), with a penalty of type BigDecimal.

Specified by:

rewardConfigurableBigDecimal in interface UniConstraintStream<A>

impact

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impact(@NonNull Score_ constraintWeight,
 @NonNull ToIntFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

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 UniConstraintStream<A>

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

impactLong

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impactLong(@NonNull Score_ constraintWeight,
 @NonNull ToLongFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.impact(Score, ToIntFunction), with an impact of type long.

Specified by:

impactLong in interface UniConstraintStream<A>

impactBigDecimal

default <Score_ extends Score<Score_>>
@NonNull UniConstraintBuilder<A,Score_> impactBigDecimal(@NonNull Score_ constraintWeight,
 @NonNull Function<A,BigDecimal> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.impact(Score, ToIntFunction), with an impact of type BigDecimal.

Specified by:

impactBigDecimal in interface UniConstraintStream<A>

impactConfigurable

default UniConstraintBuilder<A,?> impactConfigurable(ToIntFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

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 UniConstraintStream<A>

Returns:

never null

impactConfigurableLong

default UniConstraintBuilder<A,?> impactConfigurableLong(ToLongFunction<A> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.impactConfigurable(ToIntFunction), with an impact of type long.

Specified by:

impactConfigurableLong in interface UniConstraintStream<A>

impactConfigurableBigDecimal

default UniConstraintBuilder<A,?> impactConfigurableBigDecimal(Function<A,BigDecimal> matchWeigher)

Description copied from interface: UniConstraintStream

As defined by UniConstraintStream.impactConfigurable(ToIntFunction), with an impact of type BigDecimal.

Specified by:

impactConfigurableBigDecimal in interface UniConstraintStream<A>

innerImpact

<Score_ extends Score<Score_>>
UniConstraintBuilder<A,Score_> innerImpact(Score_ constraintWeight,
 ToIntFunction<A> matchWeigher,
 ScoreImpactType scoreImpactType)

innerImpact

<Score_ extends Score<Score_>>
UniConstraintBuilder<A,Score_> innerImpact(Score_ constraintWeight,
 ToLongFunction<A> matchWeigher,
 ScoreImpactType scoreImpactType)

innerImpact

<Score_ extends Score<Score_>>
UniConstraintBuilder<A,Score_> innerImpact(Score_ constraintWeight,
 Function<A,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