From 13a2d0c1660b28261ddf404d9fc2f67e32d9340e Mon Sep 17 00:00:00 2001 From: atomflunder <80397293+atomflunder@users.noreply.github.com> Date: Sat, 3 Sep 2022 00:46:57 +0200 Subject: [PATCH] Fix naming --- src/config.rs | 4 ++-- src/rating.rs | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/config.rs b/src/config.rs index 680f237..eaee30a 100644 --- a/src/config.rs +++ b/src/config.rs @@ -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. @@ -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 { diff --git a/src/rating.rs b/src/rating.rs index 5846040..dffda9a 100644 --- a/src/rating.rs +++ b/src/rating.rs @@ -214,22 +214,22 @@ impl From 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,