Class HardSoftScore
- java.lang.Object
-
- org.optaplanner.core.api.score.AbstractScore<HardSoftScore>
-
- org.optaplanner.core.api.score.buildin.hardsoft.HardSoftScore
-
- All Implemented Interfaces:
Serializable
,Comparable<HardSoftScore>
,Score<HardSoftScore>
public final class HardSoftScore extends AbstractScore<HardSoftScore>
ThisScore
is based on 2 levels of int constraints: 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 HardSoftScore
ONE_HARD
static HardSoftScore
ONE_SOFT
static HardSoftScore
ZERO
-
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 HardSoftScore
abs()
Returns a Score whose value is the absolute value of the score, i.e.HardSoftScore
add(HardSoftScore addend)
Returns a Score whose value is (this + addend).int
compareTo(HardSoftScore other)
HardSoftScore
divide(double divisor)
Returns a Score whose value is (this / divisor).boolean
equals(Object o)
int
getHardScore()
The total of the broken negative hard constraints and fulfilled positive hard constraints.int
getSoftScore()
The total of the broken negative soft constraints and fulfilled positive soft constraints.int
hashCode()
boolean
isFeasible()
APlanningSolution
is feasible if it has no broken hard constraints andScore.isSolutionInitialized()
is true.HardSoftScore
multiply(double multiplicand)
Returns a Score whose value is (this * multiplicand).HardSoftScore
negate()
Returns a Score whose value is (- this).static HardSoftScore
of(int hardScore, int softScore)
static HardSoftScore
ofHard(int hardScore)
static HardSoftScore
ofSoft(int softScore)
static HardSoftScore
ofUninitialized(int initScore, int hardScore, int softScore)
static HardSoftScore
parseScore(String scoreString)
HardSoftScore
power(double exponent)
Returns a Score whose value is (this ^ exponent).HardSoftScore
subtract(HardSoftScore subtrahend)
Returns a Score whose value is (this - subtrahend).Number[]
toLevelNumbers()
Returns an array of numbers representing the Score.String
toShortString()
LikeObject.toString()
, but trims score levels which have a zero weight.String
toString()
HardSoftScore
withInitScore(int newInitScore)
For example0hard/-8soft
with-7
returns-7init/0hard/-8soft
.HardSoftScore
zero()
Returns a Score, all levels of which are zero.-
Methods inherited from class org.optaplanner.core.api.score.AbstractScore
buildScorePattern, buildShortString, getInitPrefix, getInitScore, isSolutionInitialized, parseInitScore, parseLevelAsBigDecimal, parseLevelAsInt, parseLevelAsLong, parseScoreTokens
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.optaplanner.core.api.score.Score
isZero, toLevelDoubles
-
-
-
-
Field Detail
-
ZERO
public static final HardSoftScore ZERO
-
ONE_HARD
public static final HardSoftScore ONE_HARD
-
ONE_SOFT
public static final HardSoftScore ONE_SOFT
-
-
Method Detail
-
parseScore
public static HardSoftScore parseScore(String scoreString)
-
ofUninitialized
public static HardSoftScore ofUninitialized(int initScore, int hardScore, int softScore)
-
of
public static HardSoftScore of(int hardScore, int softScore)
-
ofHard
public static HardSoftScore ofHard(int hardScore)
-
ofSoft
public static HardSoftScore 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
-
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 score.
- Returns:
- higher is better, usually negative, 0 if no soft constraints are broken/fulfilled
-
withInitScore
public HardSoftScore withInitScore(int newInitScore)
Description copied from interface:Score
For example0hard/-8soft
with-7
returns-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:Score
APlanningSolution
is 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 HardSoftScore add(HardSoftScore addend)
Description copied from interface:Score
Returns a Score whose value is (this + addend).- Parameters:
addend
- value to be added to this Score- Returns:
- this + addend
-
subtract
public HardSoftScore subtract(HardSoftScore subtrahend)
Description copied from interface:Score
Returns a Score whose value is (this - subtrahend).- Parameters:
subtrahend
- value to be subtracted from this Score- Returns:
- this - subtrahend, rounded as necessary
-
multiply
public HardSoftScore multiply(double multiplicand)
Description copied from interface:Score
Returns 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 HardSoftScore divide(double divisor)
Description copied from interface:Score
Returns 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 HardSoftScore power(double exponent)
Description copied from interface:Score
Returns 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 HardSoftScore negate()
Description copied from interface:Score
Returns a Score whose value is (- this).- Returns:
- - this
-
abs
public HardSoftScore abs()
Description copied from interface:Score
Returns a Score whose value is the absolute value of the score, i.e. |this|.- Returns:
- never null
-
zero
public HardSoftScore zero()
Description copied from interface:Score
Returns a Score, all levels of which are zero.- Returns:
- never null
-
toLevelNumbers
public Number[] toLevelNumbers()
Description copied from interface:Score
Returns 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 specificScore
implementation.For example:
-0hard/-7soft
returnsnew int{-0, -7}
The level numbers do not contain the
Score.getInitScore()
. For example:-3init/-0hard/-7soft
also returnsnew int{-0, -7}
- Returns:
- never null
-
compareTo
public int compareTo(HardSoftScore other)
-
toShortString
public String toShortString()
Description copied from interface:Score
LikeObject.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
-
-