Package org.optaplanner.core.api.score.buildin.hardsoftbigdecimal

## Class HardSoftBigDecimalScore

- java.lang.Object
- - org.optaplanner.core.api.score.AbstractScore<HardSoftBigDecimalScore>
  - - org.optaplanner.core.api.score.buildin.hardsoftbigdecimal.HardSoftBigDecimalScore

- All Implemented Interfaces:
    `Serializable`, `Comparable<HardSoftBigDecimalScore>`, `FeasibilityScore<HardSoftBigDecimalScore>`, `Score<HardSoftBigDecimalScore>`

      public final class HardSoftBigDecimalScore
      extends AbstractScore<HardSoftBigDecimalScore>
      implements FeasibilityScore<HardSoftBigDecimalScore>

  This `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:
    `Score`, Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field | Description
    --- | --- | ---
    `static HardSoftBigDecimalScore` | `ONE_HARD` |
    `static HardSoftBigDecimalScore` | `ONE_SOFT` |
    `static HardSoftBigDecimalScore` | `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
    --- | --- | ---
    `HardSoftBigDecimalScore` | `add​(HardSoftBigDecimalScore addend)` | Returns a Score whose value is (this + addend).
    `int` | `compareTo​(HardSoftBigDecimalScore other)` |
    `HardSoftBigDecimalScore` | `divide​(double divisor)` | Returns a Score whose value is (this / divisor).
    `boolean` | `equals​(Object o)` |
    `BigDecimal` | `getHardScore()` | The total of the broken negative hard constraints and fulfilled positive hard constraints.
    `BigDecimal` | `getSoftScore()` | The total of the broken negative soft constraints and fulfilled positive soft constraints.
    `int` | `hashCode()` |
    `boolean` | `isCompatibleArithmeticArgument​(Score otherScore)` |
    `boolean` | `isFeasible()` | A `PlanningSolution` is feasible if it has no broken hard constraints and `Score.isSolutionInitialized()` is true.
    `HardSoftBigDecimalScore` | `multiply​(double multiplicand)` | Returns a Score whose value is (this * multiplicand).
    `HardSoftBigDecimalScore` | `negate()` | Returns a Score whose value is (- this).
    `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)` |
    `HardSoftBigDecimalScore` | `power​(double exponent)` | Returns a Score whose value is (this ^ exponent).
    `HardSoftBigDecimalScore` | `subtract​(HardSoftBigDecimalScore 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()` |
    `static HardSoftBigDecimalScore` | `valueOf​(BigDecimal hardScore, BigDecimal softScore)` | Deprecated. in favor of `of(BigDecimal, BigDecimal)`
    `static HardSoftBigDecimalScore` | `valueOfUninitialized​(int initScore, BigDecimal hardScore, BigDecimal softScore)` | Deprecated. in favor of `ofUninitialized(int, BigDecimal, BigDecimal)`
    `HardSoftBigDecimalScore` | `withInitScore​(int newInitScore)` | For example `0hard/-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

      `getInitScore, isSolutionInitialized, toInitializedScore`

- - ### Field Detail

    - #### ZERO

          public static final HardSoftBigDecimalScore ZERO

    - #### ONE_HARD

          public static final HardSoftBigDecimalScore ONE_HARD

    - #### ONE_SOFT

          public static final HardSoftBigDecimalScore ONE_SOFT

  - ### Method Detail

    - #### parseScore

          public static HardSoftBigDecimalScore parseScore​(String scoreString)

    - #### ofUninitialized

          public static HardSoftBigDecimalScore ofUninitialized​(int initScore,
                                                                BigDecimal hardScore,
                                                                BigDecimal softScore)

    - #### valueOfUninitialized

          @Deprecated
          public static HardSoftBigDecimalScore valueOfUninitialized​(int initScore,
                                                                     BigDecimal hardScore,
                                                                     BigDecimal softScore)

      Deprecated.
      in favor of `ofUninitialized(int, BigDecimal, BigDecimal)`

    - #### of

          public static HardSoftBigDecimalScore of​(BigDecimal hardScore,
                                                   BigDecimal softScore)

    - #### valueOf

          @Deprecated
          public static HardSoftBigDecimalScore valueOf​(BigDecimal hardScore,
                                                        BigDecimal softScore)

      Deprecated.
      in favor of `of(BigDecimal, BigDecimal)`

    - #### ofHard

          public static HardSoftBigDecimalScore ofHard​(BigDecimal hardScore)

    - #### ofSoft

          public static HardSoftBigDecimalScore ofSoft​(BigDecimal softScore)

    - #### getHardScore

          public BigDecimal getHardScore()

      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

    - #### getSoftScore

          public BigDecimal getSoftScore()

      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

    - #### withInitScore

          public HardSoftBigDecimalScore withInitScore​(int newInitScore)

      Description copied from interface: `Score`
      For example `0hard/-8soft` with `-7` returns `-7init/0hard/-8soft`.
      Specified by:
        `withInitScore` in interface `Score<HardSoftBigDecimalScore>`
      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`

    - #### isFeasible

          public boolean isFeasible()

      Description copied from interface: `FeasibilityScore`
      A `PlanningSolution` is feasible if it has no broken hard constraints and `Score.isSolutionInitialized()` is true.
      Specified by:
        `isFeasible` in interface `FeasibilityScore<HardSoftBigDecimalScore>`
      Specified by:
        `isFeasible` in interface `Score<HardSoftBigDecimalScore>`
      Returns:
        true if the hard score is 0 or higher and the `Score.getInitScore()` is 0.

    - #### add

          public HardSoftBigDecimalScore add​(HardSoftBigDecimalScore addend)

      Description copied from interface: `Score`
      Returns a Score whose value is (this + addend).
      Specified by:
        `add` in interface `Score<HardSoftBigDecimalScore>`
      Parameters:
        `addend` - value to be added to this Score
      Returns:
        this + addend

    - #### subtract

          public HardSoftBigDecimalScore subtract​(HardSoftBigDecimalScore subtrahend)

      Description copied from interface: `Score`
      Returns a Score whose value is (this - subtrahend).
      Specified by:
        `subtract` in interface `Score<HardSoftBigDecimalScore>`
      Parameters:
        `subtrahend` - value to be subtracted from this Score
      Returns:
        this - subtrahend, rounded as necessary

    - #### multiply

          public HardSoftBigDecimalScore 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.

      Specified by:
        `multiply` in interface `Score<HardSoftBigDecimalScore>`
      Parameters:
        `multiplicand` - value to be multiplied by this Score.
      Returns:
        this * multiplicand

    - #### divide

          public HardSoftBigDecimalScore 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.

      Specified by:
        `divide` in interface `Score<HardSoftBigDecimalScore>`
      Parameters:
        `divisor` - value by which this Score is to be divided
      Returns:
        this / divisor

    - #### power

          public HardSoftBigDecimalScore 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.

      Specified by:
        `power` in interface `Score<HardSoftBigDecimalScore>`
      Parameters:
        `exponent` - value by which this Score is to be powered
      Returns:
        this ^ exponent

    - #### negate

          public HardSoftBigDecimalScore negate()

      Description copied from interface: `Score`
      Returns a Score whose value is (- this).
      Specified by:
        `negate` in interface `Score<HardSoftBigDecimalScore>`
      Returns:
        - this

    - #### 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}`

      Specified by:
        `toLevelNumbers` in interface `Score<HardSoftBigDecimalScore>`
      Returns:
        never null
      See Also:
        `ScoreDefinition.fromLevelNumbers(int, Number[])`

    - #### equals

          public boolean equals​(Object o)

      Overrides:
        `equals` in class `Object`

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `Object`

    - #### compareTo

          public int compareTo​(HardSoftBigDecimalScore other)

      Specified by:
        `compareTo` in interface `Comparable<HardSoftBigDecimalScore>`

    - #### 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.

      Specified by:
        `toShortString` in interface `Score<HardSoftBigDecimalScore>`
      Returns:
        never null

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

    - #### isCompatibleArithmeticArgument

          public boolean isCompatibleArithmeticArgument​(Score otherScore)

      Specified by:
        `isCompatibleArithmeticArgument` in interface `Score<HardSoftBigDecimalScore>`
      Parameters:
        `otherScore` - never null
      Returns:
        true if the otherScore is accepted as a parameter of `Score.add(Score)`, `Score.subtract(Score)` and `Comparable.compareTo(Object)`.