glicko_2 1.1.0

Glicko2 is an iterative algorithm for ranking opponents or teams in 1v1 games.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

/*!
Tuning parameters used for rating and algorithm calculations
*/

use crate::constants;

/// Container for algorithm tuning parameters. More details available in the readme.
///
/// - `mu`: Default mean rating
/// - `phi`: Default confidence interval size
/// - `sigma`: Default Performance volatility
/// - `tau`: Default change constraint
#[derive(Debug)]
pub struct Tuning {
    pub mu: f64,
    pub phi: f64,
    pub sigma: f64,
    pub tau: f64,
}

impl Tuning {
    /// Create custom tuning parameters for the Glicko2 algorithm.
    /// The default option uses the values provided by the paper.
    ///
    /// # Example
    ///
    /// ```
    /// use glicko_2::Tuning;
    ///
    /// let default_tuning = Tuning::default();
    /// let custom_tuning = Tuning::new(1200.0, 200.0, 0.05, 0.6);
    /// ```
    pub fn new(mu: f64, phi: f64, sigma: f64, tau: f64) -> Self {
        Self {
            mu,
            phi,
            sigma,
            tau,
        }
    }
}

impl Default for Tuning {
    fn default() -> Self {
        Self {
            mu: constants::MU,
            phi: constants::PHI,
            sigma: constants::SIGMA,
            tau: constants::TAU,
        }
    }
}