Skip to content

Commit

Permalink
Fix naming
Browse files Browse the repository at this point in the history
  • Loading branch information
atomflunder committed Sep 2, 2022
1 parent b0ca250 commit 13a2d0c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ impl Default for TrueSkillConfig {
}
}

/// Constants used in the Weng calculations.
/// Constants used in the Weng-Lin calculations.
pub struct WengLinConfig {
/// The skill-class width, aka the number of difference in rating points
/// needed to have an 80% win probability against another player.
Expand All @@ -132,7 +132,7 @@ pub struct WengLinConfig {

impl WengLinConfig {
#[must_use]
/// Initialize a new `WengConfig` with a beta value of 25 / 6 ≈ `4.167`
/// Initialize a new `WengLinConfig` with a beta value of 25 / 6 ≈ `4.167`
/// and an uncertainty tolerance of `0.000_001`.
pub fn new() -> Self {
Self {
Expand Down
8 changes: 4 additions & 4 deletions src/rating.rs
Original file line number Diff line number Diff line change
Expand Up @@ -214,22 +214,22 @@ impl From<EloRating> for IngoRating {
}

#[derive(Copy, Clone, Debug, PartialEq)]
/// The Weng rating of a player.
/// The Weng-Lin rating of a player.
///
/// Similar to [`TrueSkillRating`].
///
/// The default rating is 25.0.
/// The default uncertainty is 25/3 ≈ 8.33.
pub struct WengLinRating {
/// The rating value (mu) of the WengRating, by default 25.0.
/// The rating value (mu) of the WengLinRating, by default 25.0.
pub rating: f64,
/// The uncertainty value (sigma) of the WengRating, by default 25/3 ≈ 8.33.
/// The uncertainty value (sigma) of the WengLinRating, by default 25/3 ≈ 8.33.
pub uncertainty: f64,
}

impl WengLinRating {
#[must_use]
/// Initialize a new WengRating with a rating of 25.0, and an uncertainty of 25/3 ≈ 8.33.
/// Initialize a new WengLinRating with a rating of 25.0, and an uncertainty of 25/3 ≈ 8.33.
pub fn new() -> Self {
Self {
rating: 25.0,
Expand Down

0 comments on commit 13a2d0c

Please sign in to comment.