Class HardMediumSoftBigDecimalScore
- java.lang.Object
-
- org.optaplanner.core.api.score.AbstractScore<HardMediumSoftBigDecimalScore>
-
- org.optaplanner.core.api.score.buildin.hardmediumsoftbigdecimal.HardMediumSoftBigDecimalScore
-
- All Implemented Interfaces:
Serializable
,Comparable<HardMediumSoftBigDecimalScore>
,FeasibilityScore<HardMediumSoftBigDecimalScore>
,Score<HardMediumSoftBigDecimalScore>
public final class HardMediumSoftBigDecimalScore extends AbstractScore<HardMediumSoftBigDecimalScore> implements FeasibilityScore<HardMediumSoftBigDecimalScore>
ThisScore
is based on 3 levels ofBigDecimal
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 HardMediumSoftBigDecimalScore
ONE_HARD
static HardMediumSoftBigDecimalScore
ONE_MEDIUM
static HardMediumSoftBigDecimalScore
ONE_SOFT
static HardMediumSoftBigDecimalScore
ZERO
-
Fields inherited from class org.optaplanner.core.api.score.AbstractScore
INIT_LABEL, initScore
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description HardMediumSoftBigDecimalScore
add(HardMediumSoftBigDecimalScore addend)
Returns a Score whose value is (this + addend).int
compareTo(HardMediumSoftBigDecimalScore other)
HardMediumSoftBigDecimalScore
divide(double divisor)
Returns a Score whose value is (this / divisor).boolean
equals(Object o)
BigDecimal
getHardScore()
The total of the broken negative hard constraints and fulfilled positive hard constraints.BigDecimal
getMediumScore()
The total of the broken negative medium constraints and fulfilled positive medium constraints.BigDecimal
getSoftScore()
The total of the broken negative soft constraints and fulfilled positive soft constraints.int
hashCode()
boolean
isCompatibleArithmeticArgument(Score otherScore)
boolean
isFeasible()
APlanningSolution
is feasible if it has no broken hard constraints.HardMediumSoftBigDecimalScore
multiply(double multiplicand)
Returns a Score whose value is (this * multiplicand).HardMediumSoftBigDecimalScore
negate()
Returns a Score whose value is (- this).static HardMediumSoftBigDecimalScore
of(BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
static HardMediumSoftBigDecimalScore
ofHard(BigDecimal hardScore)
static HardMediumSoftBigDecimalScore
ofMedium(BigDecimal mediumScore)
static HardMediumSoftBigDecimalScore
ofSoft(BigDecimal softScore)
static HardMediumSoftBigDecimalScore
ofUninitialized(int initScore, BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
static HardMediumSoftBigDecimalScore
parseScore(String scoreString)
HardMediumSoftBigDecimalScore
power(double exponent)
Returns a Score whose value is (this ^ exponent).HardMediumSoftBigDecimalScore
subtract(HardMediumSoftBigDecimalScore 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()
static HardMediumSoftBigDecimalScore
valueOf(BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
Deprecated.in favor ofof(BigDecimal, BigDecimal, BigDecimal)
static HardMediumSoftBigDecimalScore
valueOfUninitialized(int initScore, BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
Deprecated.HardMediumSoftBigDecimalScore
withInitScore(int newInitScore)
For example0hard/-8soft
with-7
returns-7init/0hard/-8soft
.-
Methods inherited from class org.optaplanner.core.api.score.AbstractScore
assertNoInitScore, buildScorePattern, buildShortString, getInitPrefix, getInitScore, isSolutionInitialized, parseInitScore, parseLevelAsBigDecimal, parseLevelAsDouble, 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
getInitScore, isSolutionInitialized, toInitializedScore
-
-
-
-
Field Detail
-
ZERO
public static final HardMediumSoftBigDecimalScore ZERO
-
ONE_HARD
public static final HardMediumSoftBigDecimalScore ONE_HARD
-
ONE_MEDIUM
public static final HardMediumSoftBigDecimalScore ONE_MEDIUM
-
ONE_SOFT
public static final HardMediumSoftBigDecimalScore ONE_SOFT
-
-
Method Detail
-
parseScore
public static HardMediumSoftBigDecimalScore parseScore(String scoreString)
-
ofUninitialized
public static HardMediumSoftBigDecimalScore ofUninitialized(int initScore, BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
-
valueOfUninitialized
@Deprecated public static HardMediumSoftBigDecimalScore valueOfUninitialized(int initScore, BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
Deprecated.
-
of
public static HardMediumSoftBigDecimalScore of(BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
-
valueOf
@Deprecated public static HardMediumSoftBigDecimalScore valueOf(BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)
Deprecated.in favor ofof(BigDecimal, BigDecimal, BigDecimal)
-
ofHard
public static HardMediumSoftBigDecimalScore ofHard(BigDecimal hardScore)
-
ofMedium
public static HardMediumSoftBigDecimalScore ofMedium(BigDecimal mediumScore)
-
ofSoft
public static HardMediumSoftBigDecimalScore 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
-
getMediumScore
public BigDecimal 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 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 and medium score.
- Returns:
- higher is better, usually negative, 0 if no soft constraints are broken/fulfilled
-
withInitScore
public HardMediumSoftBigDecimalScore withInitScore(int newInitScore)
Description copied from interface:Score
For example0hard/-8soft
with-7
returns-7init/0hard/-8soft
.- Specified by:
withInitScore
in interfaceScore<HardMediumSoftBigDecimalScore>
- 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()
APlanningSolution
is feasible if it has no broken hard constraints.- Specified by:
isFeasible
in interfaceFeasibilityScore<HardMediumSoftBigDecimalScore>
- Specified by:
isFeasible
in interfaceScore<HardMediumSoftBigDecimalScore>
- Returns:
- true if the
getHardScore()
is 0 or higher
-
add
public HardMediumSoftBigDecimalScore add(HardMediumSoftBigDecimalScore addend)
Description copied from interface:Score
Returns a Score whose value is (this + addend).- Specified by:
add
in interfaceScore<HardMediumSoftBigDecimalScore>
- Parameters:
addend
- value to be added to this Score- Returns:
- this + addend
-
subtract
public HardMediumSoftBigDecimalScore subtract(HardMediumSoftBigDecimalScore subtrahend)
Description copied from interface:Score
Returns a Score whose value is (this - subtrahend).- Specified by:
subtract
in interfaceScore<HardMediumSoftBigDecimalScore>
- Parameters:
subtrahend
- value to be subtracted from this Score- Returns:
- this - subtrahend, rounded as necessary
-
multiply
public HardMediumSoftBigDecimalScore 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.
- Specified by:
multiply
in interfaceScore<HardMediumSoftBigDecimalScore>
- Parameters:
multiplicand
- value to be multiplied by this Score.- Returns:
- this * multiplicand
-
divide
public HardMediumSoftBigDecimalScore 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.
- Specified by:
divide
in interfaceScore<HardMediumSoftBigDecimalScore>
- Parameters:
divisor
- value by which this Score is to be divided- Returns:
- this / divisor
-
power
public HardMediumSoftBigDecimalScore 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.
- Specified by:
power
in interfaceScore<HardMediumSoftBigDecimalScore>
- Parameters:
exponent
- value by which this Score is to be powered- Returns:
- this ^ exponent
-
negate
public HardMediumSoftBigDecimalScore negate()
Description copied from interface:Score
Returns a Score whose value is (- this).- Specified by:
negate
in interfaceScore<HardMediumSoftBigDecimalScore>
- Returns:
- - this
-
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}
- Specified by:
toLevelNumbers
in interfaceScore<HardMediumSoftBigDecimalScore>
- Returns:
- never null
- See Also:
ScoreDefinition.fromLevelNumbers(int, Number[])
-
compareTo
public int compareTo(HardMediumSoftBigDecimalScore other)
- Specified by:
compareTo
in interfaceComparable<HardMediumSoftBigDecimalScore>
-
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.- Specified by:
toShortString
in interfaceScore<HardMediumSoftBigDecimalScore>
- Returns:
- never null
-
isCompatibleArithmeticArgument
public boolean isCompatibleArithmeticArgument(Score otherScore)
- Specified by:
isCompatibleArithmeticArgument
in interfaceScore<HardMediumSoftBigDecimalScore>
- Parameters:
otherScore
- never null- Returns:
- true if the otherScore is accepted as a parameter of
Score.add(Score)
,Score.subtract(Score)
andComparable.compareTo(Object)
.
-
-