Package ai.timefold.solver.core.api.score.buildin.hardmediumsoft

Class HardMediumSoftScore

java.lang.Object
ai.timefold.solver.core.api.score.buildin.hardmediumsoft.HardMediumSoftScore
All Implemented Interfaces:
Score<HardMediumSoftScore>, Serializable, Comparable<HardMediumSoftScore>
public final class HardMediumSoftScore extends Object implements Score<HardMediumSoftScore>
This Score is based on 3 levels of int 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:

  • Field Details

  • Method Details

    • parseScore

      public static @NonNull HardMediumSoftScore parseScore(@NonNull String scoreString)

    • ofUninitialized

      public static @NonNull HardMediumSoftScore ofUninitialized(int initScore, int hardScore, int mediumScore, int softScore)

    • of

      public static @NonNull HardMediumSoftScore of(int hardScore, int mediumScore, int softScore)

    • ofHard

      public static @NonNull HardMediumSoftScore ofHard(int hardScore)

    • ofMedium

      public static @NonNull HardMediumSoftScore ofMedium(int mediumScore)

    • ofSoft

      public static @NonNull HardMediumSoftScore ofSoft(int softScore)

    • initScore

      public int initScore()
      Description copied from interface: Score
      The init score is the negative of the number of genuine planning variables set to null, unless null values are specifically allowed by PlanningVariable.allowsUnassigned() or PlanningListVariable.allowsUnassignedValues() Nulls are typically only allowed in over-constrained planning. In that case, there is no way how to tell a fully initialized solution with some values left unassigned, from a partially initialized solution where the initialization of some values wasn't yet attempted.

      During Comparable.compareTo(Object), init score is considered more important than the hard score. If the init score is 0 (which it usually is), the score's Object.toString() does not mention it.

      Specified by:
      initScore in interface Score<HardMediumSoftScore>
      Returns:
      higher is better, always negative (except in statistical calculations); 0 if all planning variables are non-null, or if nulls are allowed.

    • hardScore

      public int hardScore()
      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

    • getHardScore

      @Deprecated(forRemoval=true) public int getHardScore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use hardScore() instead.
      As defined by hardScore().

    • mediumScore

      public int mediumScore()
      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

    • getMediumScore

      @Deprecated(forRemoval=true) public int getMediumScore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use mediumScore() instead.
      As defined by mediumScore().

    • softScore

      public int softScore()
      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

    • getSoftScore

      @Deprecated(forRemoval=true) public int getSoftScore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use softScore() instead.
      As defined by softScore().

    • withInitScore

      public @NonNull HardMediumSoftScore withInitScore(int newInitScore)
      Description copied from interface: Score
      For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.
      Specified by:
      withInitScore in interface Score<HardMediumSoftScore>
      Parameters:
      newInitScore - always negative (except in statistical calculations), 0 if all planning variables are initialized
      Returns:
      equals score except that Score.initScore() is set to newInitScore

    • isFeasible

      public boolean isFeasible()
      A PlanningSolution is feasible if it has no broken hard constraints.
      Specified by:
      isFeasible in interface Score<HardMediumSoftScore>
      Returns:
      true if the hardScore() is 0 or higher

    • add

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

    • subtract

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

    • multiply

      public @NonNull HardMediumSoftScore 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<HardMediumSoftScore>
      Parameters:
      multiplicand - value to be multiplied by this Score.
      Returns:
      this * multiplicand

    • divide

      public @NonNull HardMediumSoftScore 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<HardMediumSoftScore>
      Parameters:
      divisor - value by which this Score is to be divided
      Returns:
      this / divisor

    • power

      public @NonNull HardMediumSoftScore 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<HardMediumSoftScore>
      Parameters:
      exponent - value by which this Score is to be powered
      Returns:
      this ^ exponent

    • abs

      public @NonNull HardMediumSoftScore abs()
      Description copied from interface: Score
      Returns a Score whose value is the absolute value of the score, i.e. |this|.
      Specified by:
      abs in interface Score<HardMediumSoftScore>

    • zero

      public @NonNull HardMediumSoftScore zero()
      Description copied from interface: Score
      Returns a Score, all levels of which are zero.
      Specified by:
      zero in interface Score<HardMediumSoftScore>

    • toLevelNumbers

      public Number @NonNull [] 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.initScore(). For example: -3init/-0hard/-7soft also returns new int{-0, -7}

      Specified by:
      toLevelNumbers in interface Score<HardMediumSoftScore>

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • compareTo

      public int compareTo(@NonNull HardMediumSoftScore other)
      Specified by:
      compareTo in interface Comparable<HardMediumSoftScore>

    • toShortString

      public @NonNull 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<HardMediumSoftScore>

    • toString

      public String toString()
      Overrides:
      toString in class Object