Package com.pocketcombats.openskill

Record Class RatingModelConfig

java.lang.Object
java.lang.Record
com.pocketcombats.openskill.RatingModelConfig
Record Components:
beta - Determines the spread of performance outcomes. A higher beta means outcomes are less predictable based on skill differences, while a lower beta increases the weight of skill in determining match resultsThe scaling factor for uncertainty in skills (sigma).
limitSigma - Specifies whether the model should limit the sigma (uncertainty) value growth for player ratings.
kappa - Arbitrary small positive real number that is used to prevent the variance of the posterior distribution from becoming too small or negative.
tau - Defines the dynamic adjustment of the rating's uncertainty (sigma). Higher tau values allow for faster changes in sigma. The recommended value is sigma percent.
balance - Instructs TeamRatingAggregator to modify its assumptions about users on the tail ends of the skill distribution. With balance turned on, the higher the rating a player has, it’s assumed it’s a much more monumental achievement. The inverse is true for lower rated players. Not all TeamRatingAggregator implementations may support this setting.
All Implemented Interfaces:
Serializable
public record RatingModelConfig(double beta, boolean limitSigma, double kappa, double tau, RatingModelConfig.Balance balance) extends Record implements Serializable
Configuration class for rating models, defining parameters that control the model's behavior and adjustments in player ratings after matches.
See Also:

  • Constructor Details

    • RatingModelConfig

      public RatingModelConfig(double beta, boolean limitSigma, double kappa, double tau, RatingModelConfig.Balance balance)
      Creates an instance of a RatingModelConfig record class.
      Parameters:
      beta - the value for the beta record component
      limitSigma - the value for the limitSigma record component
      kappa - the value for the kappa record component
      tau - the value for the tau record component
      balance - the value for the balance record component

  • Method Details

    • builder

      public static RatingModelConfig.Builder builder()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • beta

      public double beta()
      Returns the value of the beta record component.
      Returns:
      the value of the beta record component

    • limitSigma

      public boolean limitSigma()
      Returns the value of the limitSigma record component.
      Returns:
      the value of the limitSigma record component

    • kappa

      public double kappa()
      Returns the value of the kappa record component.
      Returns:
      the value of the kappa record component

    • tau

      public double tau()
      Returns the value of the tau record component.
      Returns:
      the value of the tau record component

    • balance

      public RatingModelConfig.Balance balance()
      Returns the value of the balance record component.
      Returns:
      the value of the balance record component