skillratings 0.1.0

Calculate a player's skill level using elo and glicko-2 algorithms.
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
53
54
55
56
57

# skillratings


Calculate a player's skill level using [Elo](https://en.wikipedia.org/wiki/Elo_rating_system) and [Glicko-2](https://en.wikipedia.org/wiki/Glicko_rating_system#Glicko-2_algorithm) algorithms known from their usage in chess and other games.  

## Usage


For a detailed guide on how to use this crate, head over [to the documentation](https://docs.rs/skillratings/).

### Elo rating system

```rust
extern crate skillratings;

use skillratings;

let player_one = skillratings::rating::EloRating { rating: 1000.0 };
let player_two = skillratings::rating::EloRating { rating: 1000.0 };

// The outcome is from the perspective of player one.
let outcome = skillratings::outcomes::Outcomes::WIN;

let (player_one_new, player_two_new) = skillratings::elo::elo(player_one, player_two, outcome, 32.0);
assert_eq!(player_one_new.rating, 1016.0);
assert_eq!(player_two_new.rating, 984.0);
```

### Glicko-2 rating system


```rust
extern crate skillratings;

use skillratings;

let player_one = skillratings::rating::GlickoRating { 
    rating: 1500.0, 
    deviation: 350.0, 
    volatility: 0.06 
};
let player_two = skillratings::rating::GlickoRating { 
    rating: 1500.0, 
    deviation: 350.0, 
    volatility: 0.06 
};

let outcome = skillratings::outcomes::Outcomes::WIN;

let (player_one_new, player_two_new) = skillratings::glicko2::glicko2(player_one, player_two, outcome, 0.5);

assert_eq!(player_one_new.rating.round(), 1662.0);
assert_eq!(player_one_new.deviation.round(), 290.0);

assert_eq!(player_two_new.rating.round(), 1338.0);
assert_eq!(player_two_new.deviation.round(), 290.0);
```

# License


This project is licensed under the [MIT License](/LICENSE).