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

Class BendableScore

java.lang.Object
ai.timefold.solver.core.api.score.buildin.bendable.BendableScore
All Implemented Interfaces:
IBendableScore<BendableScore>, Score<BendableScore>, Serializable, Comparable<BendableScore>
public final class BendableScore extends Object implements IBendableScore<BendableScore>
This Score is based on n levels of int constraints. The number of levels is bendable at configuration time.

This class is immutable.

The hardLevelsSize() and softLevelsSize() must be the same as in the BendableScoreDefinition used.

See Also:

  • Method Details

    • parseScore

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

    • ofUninitialized

      public static @NonNull BendableScore ofUninitialized(int initScore, int @NonNull [] hardScores, int @NonNull [] softScores)
      Creates a new BendableScore.
      Parameters:
      initScore - see Score.initScore()
      hardScores - never change that array afterwards: it must be immutable
      softScores - never change that array afterwards: it must be immutable

    • of

      public static @NonNull BendableScore of(int @NonNull [] hardScores, int @NonNull [] softScores)
      Creates a new BendableScore.
      Parameters:
      hardScores - never change that array afterwards: it must be immutable
      softScores - never change that array afterwards: it must be immutable

    • zero

      public static @NonNull BendableScore zero(int hardLevelsSize, int softLevelsSize)
      Creates a new BendableScore.
      Parameters:
      hardLevelsSize - at least 0
      softLevelsSize - at least 0

    • ofHard

      public static @NonNull BendableScore ofHard(int hardLevelsSize, int softLevelsSize, int hardLevel, int hardScore)
      Creates a new BendableScore.
      Parameters:
      hardLevelsSize - at least 0
      softLevelsSize - at least 0
      hardLevel - at least 0, less than hardLevelsSize
      hardScore - any

    • ofSoft

      public static @NonNull BendableScore ofSoft(int hardLevelsSize, int softLevelsSize, int softLevel, int softScore)
      Creates a new BendableScore.
      Parameters:
      hardLevelsSize - at least 0
      softLevelsSize - at least 0
      softLevel - at least 0, less than softLevelsSize
      softScore - any

    • 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<BendableScore>
      Returns:
      higher is better, always negative (except in statistical calculations); 0 if all planning variables are non-null, or if nulls are allowed.

    • hardScores

      public int @NonNull [] hardScores()
      Returns:
      array copy because this class is immutable

    • getHardScores

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

    • softScores

      public int @NonNull [] softScores()
      Returns:
      array copy because this class is immutable

    • getSoftScores

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

    • hardLevelsSize

      public int hardLevelsSize()
      Description copied from interface: IBendableScore
      The sum of this and IBendableScore.softLevelsSize() equals IBendableScore.levelsSize().
      Specified by:
      hardLevelsSize in interface IBendableScore<BendableScore>
      Returns:
      >= 0 and < IBendableScore.levelsSize()

    • hardScore

      public int hardScore(int hardLevel)
      Parameters:
      hardLevel - 0 <= hardLevel < hardLevelsSize(). The scoreLevel is hardLevel for hard levels and softLevel + hardLevelSize for soft levels.
      Returns:
      higher is better

    • getHardScore

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

    • softLevelsSize

      public int softLevelsSize()
      Description copied from interface: IBendableScore
      The sum of IBendableScore.hardLevelsSize() and this equals IBendableScore.levelsSize().
      Specified by:
      softLevelsSize in interface IBendableScore<BendableScore>
      Returns:
      >= 0 and < IBendableScore.levelsSize()

    • softScore

      public int softScore(int softLevel)
      Parameters:
      softLevel - 0 <= softLevel < softLevelsSize(). The scoreLevel is hardLevel for hard levels and softLevel + hardLevelSize for soft levels.
      Returns:
      higher is better

    • getSoftScore

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

    • withInitScore

      public @NonNull BendableScore withInitScore(int newInitScore)
      Description copied from interface: Score
      For example 0hard/-8soft with -7 returns -7init/0hard/-8soft.
      Specified by:
      withInitScore in interface Score<BendableScore>
      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

    • hardOrSoftScore

      public int hardOrSoftScore(int level)
      Parameters:
      level - 0 <= level < IBendableScore.levelsSize()
      Returns:
      higher is better

    • getHardOrSoftScore

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

    • 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.initScore() is 0.
      Specified by:
      isFeasible in interface Score<BendableScore>
      Returns:
      true if the hard score is 0 or higher and the Score.initScore() is 0.

    • add

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

    • subtract

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

    • multiply

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

    • divide

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

    • power

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

    • negate

      public @NonNull BendableScore negate()
      Description copied from interface: Score
      Returns a Score whose value is (- this).
      Specified by:
      negate in interface Score<BendableScore>
      Returns:
      - this

    • abs

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

    • zero

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

    • 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<BendableScore>

    • 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 BendableScore other)
      Specified by:
      compareTo in interface Comparable<BendableScore>

    • 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<BendableScore>

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateCompatible

      public void validateCompatible(BendableScore other)