org.optaplanner.core.api.score.buildin.bendablelong

Class BendableLongScoreHolder

java.lang.Object

org.optaplanner.core.api.score.holder.AbstractScoreHolder<BendableLongScore>

org.optaplanner.core.api.score.buildin.bendablelong.BendableLongScoreHolder

All Implemented Interfaces:

Serializable, ScoreHolder<BendableLongScore>

public class BendableLongScoreHolder
extends AbstractScoreHolder<BendableLongScore>

See Also:

BendableLongScore, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder

AbstractScoreHolder.ConstraintActivationUnMatchListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,Long>>	matchExecutorByNumberMap
protected Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,BendableLongScore>>	matchExecutorByScoreMap Slower than matchExecutorByNumberMap

Fields inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder

constraintMatchEnabled, constraintMatchTotalMap, indictmentMap, zeroScore

Constructor Summary

Constructors

Constructor and Description
BendableLongScoreHolder(boolean constraintMatchEnabled, int hardLevelsSize, int softLevelsSize)

Method Summary

Modifier and Type	Method and Description
void	addHardConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, int hardLevel, long weight)
void	addMultiConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, long[] hardWeights, long[] softWeights)
void	addSoftConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, int softLevel, long weight)
void	configureConstraintWeight(org.kie.api.definition.rule.Rule rule, BendableLongScore constraintWeight) Sets up a ConstraintWeight from the ConstraintConfiguration during initialization.
BendableLongScore	extractScore(int initScore) Extracts the Score, calculated by the KieSession for DroolsScoreDirector.
int	getHardLevelsSize()
long	getHardScore(int hardLevel)
int	getSoftLevelsSize()
long	getSoftScore(int softLevel)
void	penalize(org.kie.api.runtime.rule.RuleContext kcontext) Penalize a match by the ConstraintWeight negated.
void	penalize(org.kie.api.runtime.rule.RuleContext kcontext, long weightMultiplier) Penalize a match by the ConstraintWeight negated and multiplied with the weightMultiplier for all score levels.
void	penalize(org.kie.api.runtime.rule.RuleContext kcontext, long[] hardWeightsMultiplier, long[] softWeightsMultiplier) Penalize a match by the ConstraintWeight negated and multiplied with the specific weightMultiplier per score level.
void	reward(org.kie.api.runtime.rule.RuleContext kcontext) Reward a match by the ConstraintWeight.
void	reward(org.kie.api.runtime.rule.RuleContext kcontext, long weightMultiplier) Reward a match by the ConstraintWeight multiplied with the weightMultiplier for all score levels.
void	reward(org.kie.api.runtime.rule.RuleContext kcontext, long[] hardWeightsMultiplier, long[] softWeightsMultiplier) Reward a match by the ConstraintWeight multiplied with the specific weightMultiplier per score level.

Methods inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder

extractJustificationList, getConstraintMatchTotals, getIndictmentMap, isConstraintMatchEnabled, registerConstraintMatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

matchExecutorByNumberMap

protected final Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,Long>> matchExecutorByNumberMap

matchExecutorByScoreMap

protected final Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,BendableLongScore>> matchExecutorByScoreMap

Slower than matchExecutorByNumberMap

Constructor Detail

BendableLongScoreHolder

public BendableLongScoreHolder(boolean constraintMatchEnabled,
                               int hardLevelsSize,
                               int softLevelsSize)

Method Detail

getHardLevelsSize

public int getHardLevelsSize()

getHardScore

public long getHardScore(int hardLevel)

getSoftLevelsSize

public int getSoftLevelsSize()

getSoftScore

public long getSoftScore(int softLevel)

configureConstraintWeight

public void configureConstraintWeight(org.kie.api.definition.rule.Rule rule,
                                      BendableLongScore constraintWeight)

Description copied from interface: ScoreHolder

Sets up a ConstraintWeight from the ConstraintConfiguration during initialization.

Specified by:

configureConstraintWeight in interface ScoreHolder<BendableLongScore>

Overrides:

configureConstraintWeight in class AbstractScoreHolder<BendableLongScore>

Parameters:

rule - never null

constraintWeight - never null, with Score.getInitScore() equal to 0.

penalize

public void penalize(org.kie.api.runtime.rule.RuleContext kcontext)

Penalize a match by the ConstraintWeight negated.

Parameters:

kcontext - never null, the magic variable in DRL

penalize

public void penalize(org.kie.api.runtime.rule.RuleContext kcontext,
                     long weightMultiplier)

Penalize a match by the ConstraintWeight negated and multiplied with the weightMultiplier for all score levels.

Parameters:

kcontext - never null, the magic variable in DRL

weightMultiplier - at least 0

penalize

public void penalize(org.kie.api.runtime.rule.RuleContext kcontext,
                     long[] hardWeightsMultiplier,
                     long[] softWeightsMultiplier)

Penalize a match by the ConstraintWeight negated and multiplied with the specific weightMultiplier per score level. Slower than penalize(RuleContext, long).

Parameters:

kcontext - never null, the magic variable in DRL

hardWeightsMultiplier - elements at least 0

softWeightsMultiplier - elements at least 0

reward

public void reward(org.kie.api.runtime.rule.RuleContext kcontext)

Reward a match by the ConstraintWeight.

Parameters:

kcontext - never null, the magic variable in DRL

reward

public void reward(org.kie.api.runtime.rule.RuleContext kcontext,
                   long weightMultiplier)

Reward a match by the ConstraintWeight multiplied with the weightMultiplier for all score levels.

Parameters:

kcontext - never null, the magic variable in DRL

weightMultiplier - at least 0

reward

public void reward(org.kie.api.runtime.rule.RuleContext kcontext,
                   long[] hardWeightsMultiplier,
                   long[] softWeightsMultiplier)

Reward a match by the ConstraintWeight multiplied with the specific weightMultiplier per score level. Slower than reward(RuleContext, long).

Parameters:

kcontext - never null, the magic variable in DRL

hardWeightsMultiplier - elements at least 0

softWeightsMultiplier - elements at least 0

addHardConstraintMatch

public void addHardConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                   int hardLevel,
                                   long weight)

Parameters:

kcontext - never null, the magic variable in DRL

hardLevel - 0 <= hardLevel < getHardLevelsSize(). The scoreLevel is hardLevel for hard levels and softLevel + hardLevelSize for soft levels.

weight - higher is better, negative for a penalty, positive for a reward

addSoftConstraintMatch

public void addSoftConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                   int softLevel,
                                   long weight)

Parameters:

kcontext - never null, the magic variable in DRL

softLevel - 0 <= softLevel < getSoftLevelsSize(). The scoreLevel is hardLevel for hard levels and softLevel + hardLevelSize for soft levels.

weight - higher is better, negative for a penalty, positive for a reward

addMultiConstraintMatch

public void addMultiConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                    long[] hardWeights,
                                    long[] softWeights)

Parameters:

kcontext - never null, the magic variable in DRL

hardWeights - never null, array of length getHardLevelsSize()

softWeights - never null, array of length getSoftLevelsSize()

extractScore

public BendableLongScore extractScore(int initScore)

Description copied from interface: ScoreHolder

Extracts the Score, calculated by the KieSession for DroolsScoreDirector.

Should not be called directly, use ScoreDirector.calculateScore() instead.

Parameters:

initScore - <= 0, managed by OptaPlanner, needed as a parameter in the Score's creation method, see Score.getInitScore()

Returns:

never null, the Score of the working PlanningSolution