Class HardSoftBigDecimalScore
- java.lang.Object
-
- org.optaplanner.core.api.score.AbstractScore<HardSoftBigDecimalScore>
-
- org.optaplanner.core.api.score.buildin.hardsoftbigdecimal.HardSoftBigDecimalScore
-
- All Implemented Interfaces:
Serializable,Comparable<HardSoftBigDecimalScore>,Score<HardSoftBigDecimalScore>
public final class HardSoftBigDecimalScore extends AbstractScore<HardSoftBigDecimalScore>
ThisScoreis based on 2 levels ofBigDecimalconstraints: hard and soft. Hard constraints have priority over soft constraints. Hard constraints determine feasibility.This class is immutable.
- See Also:
Score, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static HardSoftBigDecimalScoreONE_HARDstatic HardSoftBigDecimalScoreONE_SOFTstatic HardSoftBigDecimalScoreZERO-
Fields inherited from class org.optaplanner.core.api.score.AbstractScore
INIT_LABEL, initScore
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HardSoftBigDecimalScoreadd(HardSoftBigDecimalScore addend)Returns a Score whose value is (this + addend).intcompareTo(HardSoftBigDecimalScore other)HardSoftBigDecimalScoredivide(double divisor)Returns a Score whose value is (this / divisor).booleanequals(Object o)BigDecimalgetHardScore()The total of the broken negative hard constraints and fulfilled positive hard constraints.BigDecimalgetSoftScore()The total of the broken negative soft constraints and fulfilled positive soft constraints.inthashCode()booleanisFeasible()APlanningSolutionis feasible if it has no broken hard constraints andScore.isSolutionInitialized()is true.HardSoftBigDecimalScoremultiply(double multiplicand)Returns a Score whose value is (this * multiplicand).HardSoftBigDecimalScorenegate()Returns a Score whose value is (- this).static HardSoftBigDecimalScoreof(BigDecimal hardScore, BigDecimal softScore)static HardSoftBigDecimalScoreofHard(BigDecimal hardScore)static HardSoftBigDecimalScoreofSoft(BigDecimal softScore)static HardSoftBigDecimalScoreofUninitialized(int initScore, BigDecimal hardScore, BigDecimal softScore)static HardSoftBigDecimalScoreparseScore(String scoreString)HardSoftBigDecimalScorepower(double exponent)Returns a Score whose value is (this ^ exponent).HardSoftBigDecimalScoresubtract(HardSoftBigDecimalScore subtrahend)Returns a Score whose value is (this - subtrahend).Number[]toLevelNumbers()Returns an array of numbers representing the Score.StringtoShortString()LikeObject.toString(), but trims score levels which have a zero weight.StringtoString()HardSoftBigDecimalScorewithInitScore(int newInitScore)For example0hard/-8softwith-7returns-7init/0hard/-8soft.-
Methods inherited from class org.optaplanner.core.api.score.AbstractScore
buildScorePattern, buildShortString, getInitPrefix, getInitScore, isSolutionInitialized, parseInitScore, parseLevelAsBigDecimal, parseLevelAsInt, parseLevelAsLong, parseScoreTokens
-
-
-
-
Field Detail
-
ZERO
public static final HardSoftBigDecimalScore ZERO
-
ONE_HARD
public static final HardSoftBigDecimalScore ONE_HARD
-
ONE_SOFT
public static final HardSoftBigDecimalScore ONE_SOFT
-
-
Method Detail
-
parseScore
public static HardSoftBigDecimalScore parseScore(String scoreString)
-
ofUninitialized
public static HardSoftBigDecimalScore ofUninitialized(int initScore, BigDecimal hardScore, BigDecimal softScore)
-
of
public static HardSoftBigDecimalScore of(BigDecimal hardScore, BigDecimal softScore)
-
ofHard
public static HardSoftBigDecimalScore ofHard(BigDecimal hardScore)
-
ofSoft
public static HardSoftBigDecimalScore ofSoft(BigDecimal softScore)
-
getHardScore
public BigDecimal getHardScore()
The total of the broken negative hard constraints and fulfilled positive hard constraints. Their weight is included in the total. The hard score is usually a negative number because most use cases only have negative constraints.- Returns:
- higher is better, usually negative, 0 if no hard constraints are broken/fulfilled
-
getSoftScore
public BigDecimal getSoftScore()
The total of the broken negative soft constraints and fulfilled positive soft constraints. Their weight is included in the total. The soft score is usually a negative number because most use cases only have negative constraints.In a normal score comparison, the soft score is irrelevant if the 2 scores don't have the same hard score.
- Returns:
- higher is better, usually negative, 0 if no soft constraints are broken/fulfilled
-
withInitScore
public HardSoftBigDecimalScore withInitScore(int newInitScore)
Description copied from interface:ScoreFor example0hard/-8softwith-7returns-7init/0hard/-8soft.- Parameters:
newInitScore- always negative (except in statistical calculations), 0 if all planning variables are initialized- Returns:
- equals score except that
Score.getInitScore()is set tonewInitScore
-
isFeasible
public boolean isFeasible()
Description copied from interface:ScoreAPlanningSolutionis feasible if it has no broken hard constraints andScore.isSolutionInitialized()is true. Simple scores (SimpleScore,SimpleLongScore,SimpleBigDecimalScore) are always feasible, if theirScore.getInitScore()is 0.- Returns:
- true if the hard score is 0 or higher and the
Score.getInitScore()is 0.
-
add
public HardSoftBigDecimalScore add(HardSoftBigDecimalScore addend)
Description copied from interface:ScoreReturns a Score whose value is (this + addend).- Parameters:
addend- value to be added to this Score- Returns:
- this + addend
-
subtract
public HardSoftBigDecimalScore subtract(HardSoftBigDecimalScore subtrahend)
Description copied from interface:ScoreReturns a Score whose value is (this - subtrahend).- Parameters:
subtrahend- value to be subtracted from this Score- Returns:
- this - subtrahend, rounded as necessary
-
multiply
public HardSoftBigDecimalScore multiply(double multiplicand)
Description copied from interface:ScoreReturns a Score whose value is (this * multiplicand). When rounding is needed, it should be floored (as defined byMath.floor(double)).If the implementation has a scale/precision, then the unspecified scale/precision of the double multiplicand should have no impact on the returned scale/precision.
- Parameters:
multiplicand- value to be multiplied by this Score.- Returns:
- this * multiplicand
-
divide
public HardSoftBigDecimalScore divide(double divisor)
Description copied from interface:ScoreReturns a Score whose value is (this / divisor). When rounding is needed, it should be floored (as defined byMath.floor(double)).If the implementation has a scale/precision, then the unspecified scale/precision of the double divisor should have no impact on the returned scale/precision.
- Parameters:
divisor- value by which this Score is to be divided- Returns:
- this / divisor
-
power
public HardSoftBigDecimalScore power(double exponent)
Description copied from interface:ScoreReturns a Score whose value is (this ^ exponent). When rounding is needed, it should be floored (as defined byMath.floor(double)).If the implementation has a scale/precision, then the unspecified scale/precision of the double exponent should have no impact on the returned scale/precision.
- Parameters:
exponent- value by which this Score is to be powered- Returns:
- this ^ exponent
-
negate
public HardSoftBigDecimalScore negate()
Description copied from interface:ScoreReturns a Score whose value is (- this).- Returns:
- - this
-
toLevelNumbers
public Number[] toLevelNumbers()
Description copied from interface:ScoreReturns an array of numbers representing the Score. Each number represents 1 score level. A greater score level uses a lower array index than a lesser score level.When rounding is needed, each rounding should be floored (as defined by
Math.floor(double)). The length of the returned array must be stable for a specificScoreimplementation.For example:
-0hard/-7softreturnsnew int{-0, -7}The level numbers do not contain the
Score.getInitScore(). For example:-3init/-0hard/-7softalso returnsnew int{-0, -7}- Returns:
- never null
- See Also:
ScoreDefinition.fromLevelNumbers(int, Number[])
-
compareTo
public int compareTo(HardSoftBigDecimalScore other)
-
toShortString
public String toShortString()
Description copied from interface:ScoreLikeObject.toString(), but trims score levels which have a zero weight. For example 0hard/-258soft returns -258soft.Do not use this format to persist information as text, use
Object.toString()instead, so it can be parsed reliably.- Returns:
- never null
-
-