HardMediumSoftBigDecimalScore (OptaPlanner distribution 7.27.0.Final API)

java.lang.Object
- org.optaplanner.core.api.score.AbstractScore<HardMediumSoftBigDecimalScore>
- - org.optaplanner.core.api.score.buildin.hardmediumsoftbigdecimal.HardMediumSoftBigDecimalScore

All Implemented Interfaces:

Serializable, Comparable<HardMediumSoftBigDecimalScore>, FeasibilityScore<HardMediumSoftBigDecimalScore>, Score<HardMediumSoftBigDecimalScore>
```
public final class HardMediumSoftBigDecimalScore
extends AbstractScore<HardMediumSoftBigDecimalScore>
implements FeasibilityScore<HardMediumSoftBigDecimalScore>
```
This Score is based on 3 levels of BigDecimal constraints: hard, medium and soft. Hard constraints have priority over medium constraints. Medium 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 and Description
`static HardMediumSoftBigDecimalScore`	`ONE_HARD`
`static HardMediumSoftBigDecimalScore`	`ONE_MEDIUM`
`static HardMediumSoftBigDecimalScore`	`ONE_SOFT`
`static HardMediumSoftBigDecimalScore`	`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 and Description
`HardMediumSoftBigDecimalScore`	`add(HardMediumSoftBigDecimalScore addend)` Returns a Score whose value is (this + addend).
`int`	`compareTo(HardMediumSoftBigDecimalScore other)`
`HardMediumSoftBigDecimalScore`	`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`	`getMediumScore()` The total of the broken negative medium constraints and fulfilled positive medium 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.
`HardMediumSoftBigDecimalScore`	`multiply(double multiplicand)` Returns a Score whose value is (this * multiplicand).
`HardMediumSoftBigDecimalScore`	`negate()` Returns a Score whose value is (- this).
`static HardMediumSoftBigDecimalScore`	`of(BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)`
`static HardMediumSoftBigDecimalScore`	`ofHard(BigDecimal hardScore)`
`static HardMediumSoftBigDecimalScore`	`ofMedium(BigDecimal mediumScore)`
`static HardMediumSoftBigDecimalScore`	`ofSoft(BigDecimal softScore)`
`static HardMediumSoftBigDecimalScore`	`ofUninitialized(int initScore, BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)`
`static HardMediumSoftBigDecimalScore`	`parseScore(String scoreString)`
`HardMediumSoftBigDecimalScore`	`power(double exponent)` Returns a Score whose value is (this ^ exponent).
`HardMediumSoftBigDecimalScore`	`subtract(HardMediumSoftBigDecimalScore subtrahend)` Returns a Score whose value is (this - subtrahend).
`HardMediumSoftBigDecimalScore`	`toInitializedScore()` For example `-7init/0hard/-8soft` returns `0hard/-8soft`.
`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 HardMediumSoftBigDecimalScore`	`valueOf(BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)` Deprecated. in favor of `of(BigDecimal, BigDecimal, BigDecimal)`
`static HardMediumSoftBigDecimalScore`	`valueOfUninitialized(int initScore, BigDecimal hardScore, BigDecimal mediumScore, BigDecimal softScore)` Deprecated. in favor of `ofUninitialized(int, BigDecimal, BigDecimal, BigDecimal)`
`HardMediumSoftBigDecimalScore`	`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

- Field Detail
  - ZERO
```
public static final HardMediumSoftBigDecimalScore ZERO
```
  - ONE_HARD
```
public static final HardMediumSoftBigDecimalScore ONE_HARD
```
  - ONE_MEDIUM
```
public static final HardMediumSoftBigDecimalScore ONE_MEDIUM
```
  - ONE_SOFT
```
public static final HardMediumSoftBigDecimalScore ONE_SOFT
```
- Method Detail
  - parseScore
```
public static HardMediumSoftBigDecimalScore parseScore(String scoreString)
```
  - ofUninitialized
```
public static HardMediumSoftBigDecimalScore ofUninitialized(int initScore,
                                                            BigDecimal hardScore,
                                                            BigDecimal mediumScore,
                                                            BigDecimal softScore)
```
  - valueOfUninitialized
```
@Deprecated
public static HardMediumSoftBigDecimalScore valueOfUninitialized(int initScore,
                                                                             BigDecimal hardScore,
                                                                             BigDecimal mediumScore,
                                                                             BigDecimal softScore)
```
    Deprecated. in favor of ofUninitialized(int, BigDecimal, BigDecimal, BigDecimal)
  - of
```
public static HardMediumSoftBigDecimalScore of(BigDecimal hardScore,
                                               BigDecimal mediumScore,
                                               BigDecimal softScore)
```
  - valueOf
```
@Deprecated
public static HardMediumSoftBigDecimalScore valueOf(BigDecimal hardScore,
                                                                BigDecimal mediumScore,
                                                                BigDecimal softScore)
```
    Deprecated. in favor of of(BigDecimal, BigDecimal, BigDecimal)
  - ofHard
```
public static HardMediumSoftBigDecimalScore ofHard(BigDecimal hardScore)
```
  - ofMedium
```
public static HardMediumSoftBigDecimalScore ofMedium(BigDecimal mediumScore)
```
  - ofSoft
```
public static HardMediumSoftBigDecimalScore 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
  - getMediumScore
```
public BigDecimal getMediumScore()
```
    The total of the broken negative medium constraints and fulfilled positive medium constraints. Their weight is included in the total. The medium score is usually a negative number because most use cases only have negative constraints.
    In a normal score comparison, the medium score is irrelevant if the 2 scores don't have the same hard score.
    
    Returns:
    
    higher is better, usually negative, 0 if no medium 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 and medium score.
    
    Returns:
    
    higher is better, usually negative, 0 if no soft constraints are broken/fulfilled
  - toInitializedScore
```
public HardMediumSoftBigDecimalScore toInitializedScore()
```
    Description copied from interface: Score
    
    For example -7init/0hard/-8soft returns 0hard/-8soft.
    
    Specified by:
    
    toInitializedScore in interface Score<HardMediumSoftBigDecimalScore>
    
    Returns:
    
    equal score except that Score.getInitScore() is 0.
  - withInitScore
```
public HardMediumSoftBigDecimalScore withInitScore(int newInitScore)
```
    Description copied from interface: Score
    
    For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.
    
    Specified by:
    
    withInitScore in interface Score<HardMediumSoftBigDecimalScore>
    
    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()
```
    A PlanningSolution is feasible if it has no broken hard constraints.
    
    Specified by:
    
    isFeasible in interface FeasibilityScore<HardMediumSoftBigDecimalScore>
    
    Returns:
    
    true if the getHardScore() is 0 or higher
  - add
```
public HardMediumSoftBigDecimalScore add(HardMediumSoftBigDecimalScore addend)
```
    Description copied from interface: Score
    
    Returns a Score whose value is (this + addend).
    
    Specified by:
    
    add in interface Score<HardMediumSoftBigDecimalScore>
    
    Parameters:
    
    addend - value to be added to this Score
    
    Returns:
    
    this + addend
  - subtract
```
public HardMediumSoftBigDecimalScore subtract(HardMediumSoftBigDecimalScore subtrahend)
```
    Description copied from interface: Score
    
    Returns a Score whose value is (this - subtrahend).
    
    Specified by:
    
    subtract in interface Score<HardMediumSoftBigDecimalScore>
    
    Parameters:
    
    subtrahend - value to be subtracted from this Score
    
    Returns:
    
    this - subtrahend, rounded as necessary
  - multiply
```
public HardMediumSoftBigDecimalScore 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<HardMediumSoftBigDecimalScore>
    
    Parameters:
    
    multiplicand - value to be multiplied by this Score.
    
    Returns:
    
    this * multiplicand
  - divide
```
public HardMediumSoftBigDecimalScore 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<HardMediumSoftBigDecimalScore>
    
    Parameters:
    
    divisor - value by which this Score is to be divided
    
    Returns:
    
    this / divisor
  - power
```
public HardMediumSoftBigDecimalScore 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<HardMediumSoftBigDecimalScore>
    
    Parameters:
    
    exponent - value by which this Score is to be powered
    
    Returns:
    
    this ^ exponent
  - negate
```
public HardMediumSoftBigDecimalScore negate()
```
    Description copied from interface: Score
    
    Returns a Score whose value is (- this).
    
    Specified by:
    
    negate in interface Score<HardMediumSoftBigDecimalScore>
    
    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<HardMediumSoftBigDecimalScore>
    
    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(HardMediumSoftBigDecimalScore other)
```
    Specified by:
    
    compareTo in interface Comparable<HardMediumSoftBigDecimalScore>
  - 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<HardMediumSoftBigDecimalScore>
    
    Returns:
    
    never null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isCompatibleArithmeticArgument
```
public boolean isCompatibleArithmeticArgument(Score otherScore)
```
    Specified by:
    
    isCompatibleArithmeticArgument in interface Score<HardMediumSoftBigDecimalScore>
    
    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).

Class HardMediumSoftBigDecimalScore

Field Summary

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

Method Summary

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

Field Detail

ZERO

ONE_HARD

ONE_MEDIUM

ONE_SOFT

Method Detail

parseScore

ofUninitialized

valueOfUninitialized

of

valueOf

ofHard

ofMedium

ofSoft

getHardScore

getMediumScore

getSoftScore

toInitializedScore

withInitScore

isFeasible

add

subtract

multiply

divide

power

negate

toLevelNumbers

equals

hashCode

compareTo

toShortString

toString

isCompatibleArithmeticArgument