Class BendableLongScore
- java.lang.Object
-
- org.optaplanner.core.api.score.AbstractScore<Score_>
-
- org.optaplanner.core.api.score.AbstractBendableScore<BendableLongScore>
-
- org.optaplanner.core.api.score.buildin.bendablelong.BendableLongScore
-
- All Implemented Interfaces:
Serializable,Comparable<BendableLongScore>,Score<BendableLongScore>
public final class BendableLongScore extends AbstractBendableScore<BendableLongScore>
ThisScoreis based on n levels of long constraints. The number of levels is bendable at configuration time.This class is immutable.
The
getHardLevelsSize()andgetSoftLevelsSize()must be the same as in theBendableLongScoreDefinitionused.- See Also:
Score, Serialized Form
-
-
Field Summary
-
Fields inherited from class org.optaplanner.core.api.score.AbstractBendableScore
HARD_LABEL, LEVEL_SUFFIXES, SOFT_LABEL
-
Fields inherited from class org.optaplanner.core.api.score.AbstractScore
INIT_LABEL, initScore
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedBendableLongScore(int initScore, long[] hardScores, long[] softScores)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BendableLongScoreadd(BendableLongScore addend)Returns a Score whose value is (this + addend).intcompareTo(BendableLongScore other)BendableLongScoredivide(double divisor)Returns a Score whose value is (this / divisor).booleanequals(Object o)intgetHardLevelsSize()The sum of this andAbstractBendableScore.getSoftLevelsSize()equalsAbstractBendableScore.getLevelsSize().longgetHardOrSoftScore(int index)longgetHardScore(int index)long[]getHardScores()intgetLevelsSize()intgetSoftLevelsSize()The sum ofAbstractBendableScore.getHardLevelsSize()and this equalsAbstractBendableScore.getLevelsSize().longgetSoftScore(int index)long[]getSoftScores()inthashCode()booleanisFeasible()APlanningSolutionis feasible if it has no broken hard constraints andScore.isSolutionInitialized()is true.BendableLongScoremultiply(double multiplicand)Returns a Score whose value is (this * multiplicand).BendableLongScorenegate()Returns a Score whose value is (- this).static BendableLongScoreof(long[] hardScores, long[] softScores)Creates a newBendableLongScore.static BendableLongScoreofHard(int hardLevelsSize, int softLevelsSize, int hardLevel, long hardScore)Creates a newBendableLongScore.static BendableLongScoreofSoft(int hardLevelsSize, int softLevelsSize, int softLevel, long softScore)Creates a newBendableLongScore.static BendableLongScoreofUninitialized(int initScore, long[] hardScores, long[] softScores)Creates a newBendableLongScore.static BendableLongScoreparseScore(String scoreString)BendableLongScorepower(double exponent)Returns a Score whose value is (this ^ exponent).BendableLongScoresubtract(BendableLongScore subtrahend)Returns a Score whose value is (this - subtrahend).Number[]toLevelNumbers()Returns an array of numbers representing the Score.StringtoShortString()LikeObject.toString(), but trims score levels which have a zero weight.StringtoString()voidvalidateCompatible(BendableLongScore other)BendableLongScorewithInitScore(int newInitScore)For example0hard/-8softwith-7returns-7init/0hard/-8soft.static BendableLongScorezero(int hardLevelsSize, int softLevelsSize)Creates a newBendableLongScore.-
Methods inherited from class org.optaplanner.core.api.score.AbstractBendableScore
buildBendableShortString, parseBendableScoreTokens
-
Methods inherited from class org.optaplanner.core.api.score.AbstractScore
buildScorePattern, buildShortString, getInitPrefix, getInitScore, isSolutionInitialized, parseInitScore, parseLevelAsBigDecimal, parseLevelAsInt, parseLevelAsLong, parseScoreTokens
-
-
-
-
Constructor Detail
-
BendableLongScore
protected BendableLongScore(int initScore, long[] hardScores, long[] softScores)- Parameters:
initScore- seeScore.getInitScore()hardScores- never nullsoftScores- never null
-
-
Method Detail
-
parseScore
public static BendableLongScore parseScore(String scoreString)
- Parameters:
scoreString- never null- Returns:
- never null
-
ofUninitialized
public static BendableLongScore ofUninitialized(int initScore, long[] hardScores, long[] softScores)
Creates a newBendableLongScore.- Parameters:
initScore- seeScore.getInitScore()hardScores- never null, never change that array afterwards: it must be immutablesoftScores- never null, never change that array afterwards: it must be immutable- Returns:
- never null
-
of
public static BendableLongScore of(long[] hardScores, long[] softScores)
Creates a newBendableLongScore.- Parameters:
hardScores- never null, never change that array afterwards: it must be immutablesoftScores- never null, never change that array afterwards: it must be immutable- Returns:
- never null
-
zero
public static BendableLongScore zero(int hardLevelsSize, int softLevelsSize)
Creates a newBendableLongScore.- Parameters:
hardLevelsSize- at least 0softLevelsSize- at least 0- Returns:
- never null
-
ofHard
public static BendableLongScore ofHard(int hardLevelsSize, int softLevelsSize, int hardLevel, long hardScore)
Creates a newBendableLongScore.- Parameters:
hardLevelsSize- at least 0softLevelsSize- at least 0hardLevel- at least 0, less than hardLevelsSizehardScore- any- Returns:
- never null
-
ofSoft
public static BendableLongScore ofSoft(int hardLevelsSize, int softLevelsSize, int softLevel, long softScore)
Creates a newBendableLongScore.- Parameters:
hardLevelsSize- at least 0softLevelsSize- at least 0softLevel- at least 0, less than softLevelsSizesoftScore- any- Returns:
- never null
-
getHardScores
public long[] getHardScores()
- Returns:
- not null, array copy because this class is immutable
-
getSoftScores
public long[] getSoftScores()
- Returns:
- not null, array copy because this class is immutable
-
getHardLevelsSize
public int getHardLevelsSize()
Description copied from class:AbstractBendableScoreThe sum of this andAbstractBendableScore.getSoftLevelsSize()equalsAbstractBendableScore.getLevelsSize().- Specified by:
getHardLevelsSizein classAbstractBendableScore<BendableLongScore>- Returns:
>= 0and<AbstractBendableScore.getLevelsSize()
-
getHardScore
public long getHardScore(int index)
- Parameters:
index-0 <= index <getHardLevelsSize()- Returns:
- higher is better
-
getSoftLevelsSize
public int getSoftLevelsSize()
Description copied from class:AbstractBendableScoreThe sum ofAbstractBendableScore.getHardLevelsSize()and this equalsAbstractBendableScore.getLevelsSize().- Specified by:
getSoftLevelsSizein classAbstractBendableScore<BendableLongScore>- Returns:
>= 0and<AbstractBendableScore.getLevelsSize()
-
getSoftScore
public long getSoftScore(int index)
- Parameters:
index-0 <= index <getSoftLevelsSize()- Returns:
- higher is better
-
withInitScore
public BendableLongScore withInitScore(int newInitScore)
Description copied from interface:ScoreFor example0hard/-8softwith-7returns-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
-
getLevelsSize
public int getLevelsSize()
- Specified by:
getLevelsSizein classAbstractBendableScore<BendableLongScore>- Returns:
AbstractBendableScore.getHardLevelsSize()+AbstractBendableScore.getSoftLevelsSize()
-
getHardOrSoftScore
public long getHardOrSoftScore(int index)
- Parameters:
index-0 <= index <getLevelsSize()- Returns:
- higher is better
-
isFeasible
public boolean isFeasible()
Description copied from interface:ScoreAPlanningSolutionis 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 BendableLongScore add(BendableLongScore addend)
Description copied from interface:ScoreReturns a Score whose value is (this + addend).- Parameters:
addend- value to be added to this Score- Returns:
- this + addend
-
subtract
public BendableLongScore subtract(BendableLongScore subtrahend)
Description copied from interface:ScoreReturns a Score whose value is (this - subtrahend).- Parameters:
subtrahend- value to be subtracted from this Score- Returns:
- this - subtrahend, rounded as necessary
-
multiply
public BendableLongScore multiply(double multiplicand)
Description copied from interface:ScoreReturns 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 BendableLongScore divide(double divisor)
Description copied from interface:ScoreReturns 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 BendableLongScore power(double exponent)
Description copied from interface:ScoreReturns 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 BendableLongScore negate()
Description copied from interface:ScoreReturns a Score whose value is (- this).- Returns:
- - this
-
toLevelNumbers
public Number[] toLevelNumbers()
Description copied from interface:ScoreReturns 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 specificScoreimplementation.For example:
-0hard/-7softreturnsnew int{-0, -7}The level numbers do not contain the
Score.getInitScore(). For example:-3init/-0hard/-7softalso returnsnew int{-0, -7}- Returns:
- never null
- See Also:
ScoreDefinition.fromLevelNumbers(int, Number[])
-
compareTo
public int compareTo(BendableLongScore other)
-
toShortString
public String toShortString()
Description copied from interface:ScoreLikeObject.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
-
validateCompatible
public void validateCompatible(BendableLongScore other)
-
-