Class HardSoftBigDecimalScore
- All Implemented Interfaces:
Serializable
,Comparable<HardSoftBigDecimalScore>
,Score<HardSoftBigDecimalScore>
Score
is based on 2 levels of BigDecimal
constraints: hard and soft.
Hard constraints have priority over soft constraints.
Hard constraints determine feasibility.
This class is immutable.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final HardSoftBigDecimalScore
static final HardSoftBigDecimalScore
static final HardSoftBigDecimalScore
-
Method Summary
Modifier and TypeMethodDescriptionabs()
Returns a Score whose value is the absolute value of the score, i.e.add
(HardSoftBigDecimalScore addend) Returns a Score whose value is (this + addend).int
compareTo
(HardSoftBigDecimalScore other) divide
(double divisor) Returns a Score whose value is (this / divisor).boolean
Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.UsesoftScore()
instead.The total of the broken negative hard constraints and fulfilled positive hard constraints.int
hashCode()
int
The init score is the negative of the number of uninitialized genuine planning variables.boolean
APlanningSolution
is feasible if it has no broken hard constraints andScore.isSolutionInitialized()
is true.multiply
(double multiplicand) Returns a Score whose value is (this * multiplicand).static HardSoftBigDecimalScore
of
(BigDecimal hardScore, BigDecimal softScore) static HardSoftBigDecimalScore
ofHard
(BigDecimal hardScore) static HardSoftBigDecimalScore
ofSoft
(BigDecimal softScore) static HardSoftBigDecimalScore
ofUninitialized
(int initScore, BigDecimal hardScore, BigDecimal softScore) static HardSoftBigDecimalScore
parseScore
(String scoreString) power
(double exponent) Returns a Score whose value is (this ^ exponent).The total of the broken negative soft constraints and fulfilled positive soft constraints.subtract
(HardSoftBigDecimalScore subtrahend) Returns a Score whose value is (this - subtrahend).Number[]
Returns an array of numbers representing the Score.LikeObject.toString()
, but trims score levels which have a zero weight.toString()
withInitScore
(int newInitScore) For example0hard/-8soft
with-7
returns-7init/0hard/-8soft
.zero()
Returns a Score, all levels of which are zero.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, isZero, negate, toLevelDoubles
-
Field Details
-
ZERO
-
ONE_HARD
-
ONE_SOFT
-
-
Method Details
-
parseScore
-
ofUninitialized
public static HardSoftBigDecimalScore ofUninitialized(int initScore, BigDecimal hardScore, BigDecimal softScore) -
of
-
ofHard
-
ofSoft
-
initScore
public int initScore()Description copied from interface:Score
The init score is the negative of the number of uninitialized genuine planning variables. If it's 0 (which it usually is), thePlanningSolution
is fully initialized and the score'sObject.toString()
does not mention it.During
Comparable.compareTo(Object)
, it's even more important than the hard score: if you don't want this behaviour, read about overconstrained planning in the reference manual.- Specified by:
initScore
in interfaceScore<HardSoftBigDecimalScore>
- Returns:
- higher is better, always negative (except in statistical calculations), 0 if all planning variables are initialized
-
hardScore
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
-
getHardScore
Deprecated, for removal: This API element is subject to removal in a future version.UsehardScore()
instead.As defined byhardScore()
. -
softScore
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
-
getSoftScore
Deprecated, for removal: This API element is subject to removal in a future version.UsesoftScore()
instead.As defined bysoftScore()
. -
withInitScore
Description copied from interface:Score
For example0hard/-8soft
with-7
returns-7init/0hard/-8soft
.- Specified by:
withInitScore
in interfaceScore<HardSoftBigDecimalScore>
- Parameters:
newInitScore
- always negative (except in statistical calculations), 0 if all planning variables are initialized- Returns:
- equals score except that
Score.initScore()
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.initScore()
is 0.- Specified by:
isFeasible
in interfaceScore<HardSoftBigDecimalScore>
- Returns:
- true if the hard score is 0 or higher and the
Score.initScore()
is 0.
-
add
Description copied from interface:Score
Returns a Score whose value is (this + addend).- Specified by:
add
in interfaceScore<HardSoftBigDecimalScore>
- Parameters:
addend
- value to be added to this Score- Returns:
- this + addend
-
subtract
Description copied from interface:Score
Returns a Score whose value is (this - subtrahend).- Specified by:
subtract
in interfaceScore<HardSoftBigDecimalScore>
- Parameters:
subtrahend
- value to be subtracted from this Score- Returns:
- this - subtrahend, rounded as necessary
-
multiply
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<HardSoftBigDecimalScore>
- Parameters:
multiplicand
- value to be multiplied by this Score.- Returns:
- this * multiplicand
-
divide
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<HardSoftBigDecimalScore>
- Parameters:
divisor
- value by which this Score is to be divided- Returns:
- this / divisor
-
power
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<HardSoftBigDecimalScore>
- Parameters:
exponent
- value by which this Score is to be powered- Returns:
- this ^ exponent
-
abs
Description copied from interface:Score
Returns a Score whose value is the absolute value of the score, i.e. |this|.- Specified by:
abs
in interfaceScore<HardSoftBigDecimalScore>
- Returns:
- never null
-
zero
Description copied from interface:Score
Returns a Score, all levels of which are zero.- Specified by:
zero
in interfaceScore<HardSoftBigDecimalScore>
- Returns:
- never null
-
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.initScore()
. For example:-3init/-0hard/-7soft
also returnsnew int{-0, -7}
- Specified by:
toLevelNumbers
in interfaceScore<HardSoftBigDecimalScore>
- Returns:
- never null
-
equals
-
hashCode
public int hashCode() -
compareTo
- Specified by:
compareTo
in interfaceComparable<HardSoftBigDecimalScore>
-
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<HardSoftBigDecimalScore>
- Returns:
- never null
-
toString
-
hardScore()
instead.