Class HardMediumSoftScore
- java.lang.Object
-
- org.optaplanner.core.api.score.AbstractScore<HardMediumSoftScore>
-
- org.optaplanner.core.api.score.buildin.hardmediumsoft.HardMediumSoftScore
-
- All Implemented Interfaces:
Serializable,Comparable<HardMediumSoftScore>,Score<HardMediumSoftScore>
public final class HardMediumSoftScore extends AbstractScore<HardMediumSoftScore>
ThisScoreis based on 3 levels of int constraints: hard, medium and soft. Hard constraints have priority over medium constraints. Medium 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 HardMediumSoftScoreONE_HARDstatic HardMediumSoftScoreONE_MEDIUMstatic HardMediumSoftScoreONE_SOFTstatic HardMediumSoftScoreZERO-
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 HardMediumSoftScoreadd(HardMediumSoftScore addend)Returns a Score whose value is (this + addend).intcompareTo(HardMediumSoftScore other)HardMediumSoftScoredivide(double divisor)Returns a Score whose value is (this / divisor).booleanequals(Object o)intgetHardScore()The total of the broken negative hard constraints and fulfilled positive hard constraints.intgetMediumScore()The total of the broken negative medium constraints and fulfilled positive medium constraints.intgetSoftScore()The total of the broken negative soft constraints and fulfilled positive soft constraints.inthashCode()booleanisFeasible()APlanningSolutionis feasible if it has no broken hard constraints.HardMediumSoftScoremultiply(double multiplicand)Returns a Score whose value is (this * multiplicand).HardMediumSoftScorenegate()Returns a Score whose value is (- this).static HardMediumSoftScoreof(int hardScore, int mediumScore, int softScore)static HardMediumSoftScoreofHard(int hardScore)static HardMediumSoftScoreofMedium(int mediumScore)static HardMediumSoftScoreofSoft(int softScore)static HardMediumSoftScoreofUninitialized(int initScore, int hardScore, int mediumScore, int softScore)static HardMediumSoftScoreparseScore(String scoreString)HardMediumSoftScorepower(double exponent)Returns a Score whose value is (this ^ exponent).HardMediumSoftScoresubtract(HardMediumSoftScore 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()HardMediumSoftScorewithInitScore(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 HardMediumSoftScore ZERO
-
ONE_HARD
public static final HardMediumSoftScore ONE_HARD
-
ONE_MEDIUM
public static final HardMediumSoftScore ONE_MEDIUM
-
ONE_SOFT
public static final HardMediumSoftScore ONE_SOFT
-
-
Method Detail
-
parseScore
public static HardMediumSoftScore parseScore(String scoreString)
-
ofUninitialized
public static HardMediumSoftScore ofUninitialized(int initScore, int hardScore, int mediumScore, int softScore)
-
of
public static HardMediumSoftScore of(int hardScore, int mediumScore, int softScore)
-
ofHard
public static HardMediumSoftScore ofHard(int hardScore)
-
ofMedium
public static HardMediumSoftScore ofMedium(int mediumScore)
-
ofSoft
public static HardMediumSoftScore ofSoft(int softScore)
-
getHardScore
public int 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
-
getMediumScore
public int getMediumScore()
The total of the broken negative medium constraints and fulfilled positive medium constraints. Their weight is included in the total. The medium score is usually a negative number because most use cases only have negative constraints.In a normal score comparison, the medium score is irrelevant if the 2 scores don't have the same hard score.
- Returns:
- higher is better, usually negative, 0 if no medium constraints are broken/fulfilled
-
getSoftScore
public int 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 and medium score.
- Returns:
- higher is better, usually negative, 0 if no soft constraints are broken/fulfilled
-
withInitScore
public HardMediumSoftScore 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()
APlanningSolutionis feasible if it has no broken hard constraints.- Returns:
- true if the
getHardScore()is 0 or higher
-
add
public HardMediumSoftScore add(HardMediumSoftScore 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 HardMediumSoftScore subtract(HardMediumSoftScore 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 HardMediumSoftScore 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 HardMediumSoftScore 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 HardMediumSoftScore 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 HardMediumSoftScore 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(HardMediumSoftScore 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
-
-