org.optaplanner.core.api.score.buildin.hardsoftdouble

Class HardSoftDoubleScoreHolder

java.lang.Object

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

org.optaplanner.core.api.score.buildin.hardsoftdouble.HardSoftDoubleScoreHolder

All Implemented Interfaces:

Serializable, ScoreHolder<HardSoftDoubleScore>

public class HardSoftDoubleScoreHolder
extends AbstractScoreHolder<HardSoftDoubleScore>

WARNING: NOT RECOMMENDED TO USE DUE TO ROUNDING ERRORS THAT CAUSE SCORE CORRUPTION. Use HardSoftBigDecimalScoreHolder instead.

See Also:

HardSoftDoubleScore, 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 double	hardScore
protected Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,Double>>	matchExecutorByNumberMap
protected Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,HardSoftDoubleScore>>	matchExecutorByScoreMap Slower than matchExecutorByNumberMap
protected double	softScore

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

constraintMatchEnabled, constraintMatchTotalMap, indictmentMap, zeroScore

Constructor Summary

Constructors

Constructor and Description
HardSoftDoubleScoreHolder(boolean constraintMatchEnabled)

Method Summary

Modifier and Type	Method and Description
void	addHardConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, double hardWeight)
void	addMultiConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, double hardWeight, double softWeight)
void	addSoftConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, double softWeight)
void	configureConstraintWeight(org.kie.api.definition.rule.Rule rule, HardSoftDoubleScore constraintWeight) Sets up a ConstraintWeight from the ConstraintConfiguration during initialization.
HardSoftDoubleScore	extractScore(int initScore) Extracts the Score, calculated by the KieSession for DroolsScoreDirector.
double	getHardScore()
double	getSoftScore()
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, double 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, double hardWeightMultiplier, double softWeightMultiplier) 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, double weightMultiplier) Reward a match by the ConstraintWeight multiplied with the weightMultiplier for all score levels.
void	reward(org.kie.api.runtime.rule.RuleContext kcontext, double hardWeightMultiplier, double softWeightMultiplier) 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,Double>> matchExecutorByNumberMap

matchExecutorByScoreMap

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

Slower than matchExecutorByNumberMap

hardScore

protected double hardScore

softScore

protected double softScore

Constructor Detail

HardSoftDoubleScoreHolder

public HardSoftDoubleScoreHolder(boolean constraintMatchEnabled)

Method Detail

getHardScore

public double getHardScore()

getSoftScore

public double getSoftScore()

configureConstraintWeight

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

Description copied from interface: ScoreHolder

Sets up a ConstraintWeight from the ConstraintConfiguration during initialization.

Specified by:

configureConstraintWeight in interface ScoreHolder<HardSoftDoubleScore>

Overrides:

configureConstraintWeight in class AbstractScoreHolder<HardSoftDoubleScore>

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,
                     double 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,
                     double hardWeightMultiplier,
                     double softWeightMultiplier)

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

Parameters:

kcontext - never null, the magic variable in DRL

hardWeightMultiplier - at least 0

softWeightMultiplier - 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,
                   double 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,
                   double hardWeightMultiplier,
                   double softWeightMultiplier)

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

Parameters:

kcontext - never null, the magic variable in DRL

hardWeightMultiplier - at least 0

softWeightMultiplier - at least 0

addHardConstraintMatch

public void addHardConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                   double hardWeight)

Parameters:

kcontext - never null, the magic variable in DRL

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

addSoftConstraintMatch

public void addSoftConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                   double softWeight)

Parameters:

kcontext - never null, the magic variable in DRL

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

addMultiConstraintMatch

public void addMultiConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                    double hardWeight,
                                    double softWeight)

Parameters:

kcontext - never null, the magic variable in DRL

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

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

extractScore

public HardSoftDoubleScore 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