Class SimpleScore
- All Implemented Interfaces:
Serializable
,Comparable<SimpleScore>
,Score<SimpleScore>
Score
is based on 1 level of int constraints.
This class is immutable.
- See Also:
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionabs()
Returns a Score whose value is the absolute value of the score, i.e.add
(SimpleScore addend) Returns a Score whose value is (this + addend).int
compareTo
(SimpleScore other) divide
(double divisor) Returns a Score whose value is (this / divisor).boolean
int
getScore()
Deprecated, for removal: This API element is subject to removal in a future version.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 SimpleScore
of
(int score) static SimpleScore
ofUninitialized
(int initScore, int score) static SimpleScore
parseScore
(String scoreString) power
(double exponent) Returns a Score whose value is (this ^ exponent).int
score()
The total of the broken negative constraints and fulfilled positive constraints.subtract
(SimpleScore 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
-
-
Method Details
-
parseScore
-
ofUninitialized
-
of
-
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<SimpleScore>
- Returns:
- higher is better, always negative (except in statistical calculations), 0 if all planning variables are initialized
-
score
public int score()The total of the broken negative constraints and fulfilled positive constraints. Their weight is included in the total. The score is usually a negative number because most use cases only have negative constraints.- Returns:
- higher is better, usually negative, 0 if no constraints are broken/fulfilled
-
getScore
Deprecated, for removal: This API element is subject to removal in a future version.Usescore()
instead.As defined byscore()
. -
withInitScore
Description copied from interface:Score
For example0hard/-8soft
with-7
returns-7init/0hard/-8soft
.- Specified by:
withInitScore
in interfaceScore<SimpleScore>
- 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
-
add
Description copied from interface:Score
Returns a Score whose value is (this + addend).- Specified by:
add
in interfaceScore<SimpleScore>
- 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<SimpleScore>
- 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<SimpleScore>
- 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<SimpleScore>
- 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<SimpleScore>
- 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<SimpleScore>
- Returns:
- never null
-
zero
Description copied from interface:Score
Returns a Score, all levels of which are zero.- Specified by:
zero
in interfaceScore<SimpleScore>
- Returns:
- never null
-
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<SimpleScore>
- Returns:
- true if the hard score is 0 or higher and the
Score.initScore()
is 0.
-
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<SimpleScore>
- Returns:
- never null
-
equals
-
hashCode
public int hashCode() -
compareTo
- Specified by:
compareTo
in interfaceComparable<SimpleScore>
-
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<SimpleScore>
- Returns:
- never null
-
toString
-
score()
instead.