Class SimpleLongScore
- java.lang.Object
-
- org.optaplanner.core.api.score.AbstractScore<SimpleLongScore>
-
- org.optaplanner.core.api.score.buildin.simplelong.SimpleLongScore
-
- All Implemented Interfaces:
Serializable
,Comparable<SimpleLongScore>
,Score<SimpleLongScore>
public final class SimpleLongScore extends AbstractScore<SimpleLongScore>
ThisScore
is based on 1 level of long constraints.This class is immutable.
- See Also:
Score
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static SimpleLongScore
ONE
static SimpleLongScore
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 SimpleLongScore
add(SimpleLongScore addend)
Returns a Score whose value is (this + addend).int
compareTo(SimpleLongScore other)
SimpleLongScore
divide(double divisor)
Returns a Score whose value is (this / divisor).boolean
equals(Object o)
long
getScore()
The total of the broken negative constraints and fulfilled positive constraints.int
hashCode()
boolean
isCompatibleArithmeticArgument(Score otherScore)
boolean
isFeasible()
APlanningSolution
is feasible if it has no broken hard constraints andScore.isSolutionInitialized()
is true.SimpleLongScore
multiply(double multiplicand)
Returns a Score whose value is (this * multiplicand).SimpleLongScore
negate()
Returns a Score whose value is (- this).static SimpleLongScore
of(long score)
static SimpleLongScore
ofUninitialized(int initScore, long score)
static SimpleLongScore
parseScore(String scoreString)
SimpleLongScore
power(double exponent)
Returns a Score whose value is (this ^ exponent).SimpleLongScore
subtract(SimpleLongScore 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 SimpleLongScore
valueOf(long score)
Deprecated.in favor ofof(long)
static SimpleLongScore
valueOfUninitialized(int initScore, long score)
Deprecated.in favor ofofUninitialized(int, long)
SimpleLongScore
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
toInitializedScore
-
-
-
-
Field Detail
-
ZERO
public static final SimpleLongScore ZERO
-
ONE
public static final SimpleLongScore ONE
-
-
Method Detail
-
parseScore
public static SimpleLongScore parseScore(String scoreString)
-
ofUninitialized
public static SimpleLongScore ofUninitialized(int initScore, long score)
-
valueOfUninitialized
@Deprecated public static SimpleLongScore valueOfUninitialized(int initScore, long score)
Deprecated.in favor ofofUninitialized(int, long)
-
of
public static SimpleLongScore of(long score)
-
valueOf
@Deprecated public static SimpleLongScore valueOf(long score)
Deprecated.in favor ofof(long)
-
getScore
public long getScore()
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
-
withInitScore
public SimpleLongScore 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
-
add
public SimpleLongScore add(SimpleLongScore 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 SimpleLongScore subtract(SimpleLongScore 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 SimpleLongScore 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 SimpleLongScore 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 SimpleLongScore 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 SimpleLongScore negate()
Description copied from interface:Score
Returns a Score whose value is (- this).- Returns:
- - this
-
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.
-
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
- See Also:
ScoreDefinition.fromLevelNumbers(int, Number[])
-
compareTo
public int compareTo(SimpleLongScore 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
-
isCompatibleArithmeticArgument
public boolean isCompatibleArithmeticArgument(Score otherScore)
- Parameters:
otherScore
- never null- Returns:
- true if the otherScore is accepted as a parameter of
Score.add(Score)
,Score.subtract(Score)
andComparable.compareTo(Object)
.
-
-