java.lang.Object
- org.optaplanner.core.api.score.AbstractScore<Score_>
- - org.optaplanner.core.api.score.AbstractBendableScore<BendableBigDecimalScore>
  - - org.optaplanner.core.api.score.buildin.bendablebigdecimal.BendableBigDecimalScore

All Implemented Interfaces:

Serializable, Comparable<BendableBigDecimalScore>, Score<BendableBigDecimalScore>
```
public final class BendableBigDecimalScore
extends AbstractBendableScore<BendableBigDecimalScore>
```
This Score is based on n levels of BigDecimal constraints. The number of levels is bendable at configuration time.
This class is immutable.
The getHardLevelsSize() and getSoftLevelsSize() must be the same as in the BendableScoreDefinition used.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BendableBigDecimalScore`	`add(BendableBigDecimalScore addend)`	Returns a Score whose value is (this + addend).
`int`	`compareTo(BendableBigDecimalScore other)`
`BendableBigDecimalScore`	`divide(double divisor)`	Returns a Score whose value is (this / divisor).
`boolean`	`equals(Object o)`
`int`	`getHardLevelsSize()`	The sum of this and `AbstractBendableScore.getSoftLevelsSize()` equals `AbstractBendableScore.getLevelsSize()`.
`BigDecimal`	`getHardOrSoftScore(int index)`
`BigDecimal`	`getHardScore(int index)`
`BigDecimal[]`	`getHardScores()`
`int`	`getLevelsSize()`
`int`	`getSoftLevelsSize()`	The sum of `AbstractBendableScore.getHardLevelsSize()` and this equals `AbstractBendableScore.getLevelsSize()`.
`BigDecimal`	`getSoftScore(int index)`
`BigDecimal[]`	`getSoftScores()`
`int`	`hashCode()`
`boolean`	`isFeasible()`	A `PlanningSolution` is feasible if it has no broken hard constraints and `Score.isSolutionInitialized()` is true.
`BendableBigDecimalScore`	`multiply(double multiplicand)`	Returns a Score whose value is (this * multiplicand).
`BendableBigDecimalScore`	`negate()`	Returns a Score whose value is (- this).
`static BendableBigDecimalScore`	`of(BigDecimal[] hardScores, BigDecimal[] softScores)`	Creates a new `BendableBigDecimalScore`.
`static BendableBigDecimalScore`	`ofHard(int hardLevelsSize, int softLevelsSize, int hardLevel, BigDecimal hardScore)`	Creates a new `BendableBigDecimalScore`.
`static BendableBigDecimalScore`	`ofSoft(int hardLevelsSize, int softLevelsSize, int softLevel, BigDecimal softScore)`	Creates a new `BendableBigDecimalScore`.
`static BendableBigDecimalScore`	`ofUninitialized(int initScore, BigDecimal[] hardScores, BigDecimal[] softScores)`	Creates a new `BendableBigDecimalScore`.
`static BendableBigDecimalScore`	`parseScore(String scoreString)`
`BendableBigDecimalScore`	`power(double exponent)`	Returns a Score whose value is (this ^ exponent).
`BendableBigDecimalScore`	`subtract(BendableBigDecimalScore subtrahend)`	Returns a Score whose value is (this - subtrahend).
`Number[]`	`toLevelNumbers()`	Returns an array of numbers representing the Score.
`String`	`toShortString()`	Like `Object.toString()`, but trims score levels which have a zero weight.
`String`	`toString()`
`void`	`validateCompatible(BendableBigDecimalScore other)`
`BendableBigDecimalScore`	`withInitScore(int newInitScore)`	For example `0hard/-8soft` with `-7` returns `-7init/0hard/-8soft`.
`BendableBigDecimalScore`	`zero()`	Returns a Score, all levels of which are zero.
`static BendableBigDecimalScore`	`zero(int hardLevelsSize, int softLevelsSize)`	Creates a new `BendableBigDecimalScore`.

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

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
isZero, toLevelDoubles

- Method Detail
  - parseScore
```
public static BendableBigDecimalScore parseScore(String scoreString)
```
    Parameters:
    
    scoreString - never null
    
    Returns:
    
    never null
  - ofUninitialized
```
public static BendableBigDecimalScore ofUninitialized(int initScore,
                                                      BigDecimal[] hardScores,
                                                      BigDecimal[] softScores)
```
    Creates a new BendableBigDecimalScore.
    
    Parameters:
    
    initScore - see Score.getInitScore()
    
    hardScores - never null, never change that array afterwards: it must be immutable
    
    softScores - never null, never change that array afterwards: it must be immutable
    
    Returns:
    
    never null
  - of
```
public static BendableBigDecimalScore of(BigDecimal[] hardScores,
                                         BigDecimal[] softScores)
```
    Creates a new BendableBigDecimalScore.
    
    Parameters:
    
    hardScores - never null, never change that array afterwards: it must be immutable
    
    softScores - never null, never change that array afterwards: it must be immutable
    
    Returns:
    
    never null
  - zero
```
public static BendableBigDecimalScore zero(int hardLevelsSize,
                                           int softLevelsSize)
```
    Creates a new BendableBigDecimalScore.
    
    Parameters:
    
    hardLevelsSize - at least 0
    
    softLevelsSize - at least 0
    
    Returns:
    
    never null
  - ofHard
```
public static BendableBigDecimalScore ofHard(int hardLevelsSize,
                                             int softLevelsSize,
                                             int hardLevel,
                                             BigDecimal hardScore)
```
    Creates a new BendableBigDecimalScore.
    
    Parameters:
    
    hardLevelsSize - at least 0
    
    softLevelsSize - at least 0
    
    hardLevel - at least 0, less than hardLevelsSize
    
    hardScore - never null
    
    Returns:
    
    never null
  - ofSoft
```
public static BendableBigDecimalScore ofSoft(int hardLevelsSize,
                                             int softLevelsSize,
                                             int softLevel,
                                             BigDecimal softScore)
```
    Creates a new BendableBigDecimalScore.
    
    Parameters:
    
    hardLevelsSize - at least 0
    
    softLevelsSize - at least 0
    
    softLevel - at least 0, less than softLevelsSize
    
    softScore - never null
    
    Returns:
    
    never null
  - getHardScores
```
public BigDecimal[] getHardScores()
```
    Returns:
    
    not null, array copy because this class is immutable
  - getSoftScores
```
public BigDecimal[] getSoftScores()
```
    Returns:
    
    not null, array copy because this class is immutable
  - getHardLevelsSize
```
public int getHardLevelsSize()
```
    Description copied from class: AbstractBendableScore
    
    The sum of this and AbstractBendableScore.getSoftLevelsSize() equals AbstractBendableScore.getLevelsSize().
    
    Specified by:
    
    getHardLevelsSize in class AbstractBendableScore<BendableBigDecimalScore>
    
    Returns:
    
    >= 0 and < AbstractBendableScore.getLevelsSize()
  - getHardScore
```
public BigDecimal getHardScore(int index)
```
    Parameters:
    
    index - 0 <= index < getHardLevelsSize()
    
    Returns:
    
    higher is better
  - getSoftLevelsSize
```
public int getSoftLevelsSize()
```
    Description copied from class: AbstractBendableScore
    
    The sum of AbstractBendableScore.getHardLevelsSize() and this equals AbstractBendableScore.getLevelsSize().
    
    Specified by:
    
    getSoftLevelsSize in class AbstractBendableScore<BendableBigDecimalScore>
    
    Returns:
    
    >= 0 and < AbstractBendableScore.getLevelsSize()
  - getSoftScore
```
public BigDecimal getSoftScore(int index)
```
    Parameters:
    
    index - 0 <= index < getSoftLevelsSize()
    
    Returns:
    
    higher is better
  - withInitScore
```
public BendableBigDecimalScore withInitScore(int newInitScore)
```
    Description copied from interface: Score
    
    For example 0hard/-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 to newInitScore
  - getLevelsSize
```
public int getLevelsSize()
```
    Specified by:
    
    getLevelsSize in class AbstractBendableScore<BendableBigDecimalScore>
    
    Returns:
    
    AbstractBendableScore.getHardLevelsSize() + AbstractBendableScore.getSoftLevelsSize()
  - getHardOrSoftScore
```
public BigDecimal getHardOrSoftScore(int index)
```
    Parameters:
    
    index - 0 <= index < getLevelsSize()
    
    Returns:
    
    higher is better
  - isFeasible
```
public boolean isFeasible()
```
    Description copied from interface: Score
    
    A PlanningSolution is feasible if it has no broken hard constraints and Score.isSolutionInitialized() is true. Simple scores (SimpleScore, SimpleLongScore, SimpleBigDecimalScore) are always feasible, if their Score.getInitScore() is 0.
    
    Returns:
    
    true if the hard score is 0 or higher and the Score.getInitScore() is 0.
  - add
```
public BendableBigDecimalScore add(BendableBigDecimalScore 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 BendableBigDecimalScore subtract(BendableBigDecimalScore 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 BendableBigDecimalScore 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 by Math.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 BendableBigDecimalScore 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 by Math.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 BendableBigDecimalScore 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 by Math.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 BendableBigDecimalScore negate()
```
    Description copied from interface: Score
    
    Returns a Score whose value is (- this).
    
    Returns:
    
    - this
  - zero
```
public BendableBigDecimalScore zero()
```
    Description copied from interface: Score
    
    Returns a Score, all levels of which are zero.
    
    Returns:
    
    never null
  - 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 specific Score implementation.
    For example: -0hard/-7soft returns new int{-0, -7}
    The level numbers do not contain the Score.getInitScore(). For example: -3init/-0hard/-7soft also returns new int{-0, -7}
    
    Returns:
    
    never null
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(BendableBigDecimalScore other)
```
  - toShortString
```
public String toShortString()
```
    Description copied from interface: Score
    
    Like Object.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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateCompatible
```
public void validateCompatible(BendableBigDecimalScore other)
```

Class BendableBigDecimalScore

Field Summary

Fields inherited from class org.optaplanner.core.api.score.AbstractBendableScore

Fields inherited from class org.optaplanner.core.api.score.AbstractScore

Method Summary

Methods inherited from class org.optaplanner.core.api.score.AbstractBendableScore

Methods inherited from class org.optaplanner.core.api.score.AbstractScore

Methods inherited from class java.lang.Object

Methods inherited from interface org.optaplanner.core.api.score.Score

Method Detail

parseScore

ofUninitialized

of

zero

ofHard

ofSoft

getHardScores

getSoftScores

getHardLevelsSize

getHardScore

getSoftLevelsSize

getSoftScore

withInitScore

getLevelsSize

getHardOrSoftScore

isFeasible

add

subtract

multiply

divide

power

negate

zero

toLevelNumbers

equals

hashCode

compareTo

toShortString

toString

validateCompatible