package glicko2

You can search for identifiers within the package.

in-package search v0.2.0

package glicko2

glicko2
- Glicko2
  - Default
    
    LowLevel
    
    SingleGame
  - Make
    
    Config
    
    LowLevel
    
    SingleGame
- Glicko2_types
  - GLICKO2
    
    LowLevel
    
    SingleGame
  - GLICKO2_CONFIG
  - LOW_LEVEL
  - PLAYER
  - SINGLE_GAME

Legend:
Library
Module
Module type
Parameter
Class
Class type

include Glicko2_types.PLAYER

type player = {

rating : float;
rating_deviation : float;
volatility : float;

}

The type containing the data need for the Glicko2 algorithm. You can create this structure yourself, but we recommend you use the "default_player" function defined in this module.

type player_result = (player, Glicko2_types.player_error) Glicko2_types.result

type game_outcome = [

| `Player1Win
| `Player2Win
| `Draw

]

type new_ratings = {

new_player1 : player;
new_player2 : player;

}

type game_result = {

player1 : player;
player2 : player;
game_outcome : game_outcome;

}

The input type to the Glicko2 rating functions. The two players, and the outcome of the game.

val default_player : 
  ?rating:int ->
  ?rating_deviation:int ->
  unit ->
  player_result

The recommended way of creating a new player. It will have a rating of 1500 (unless overwritten), a rating deviation of 350 (unless overwritten), and a volatility of 0.06.

val rate : game_result -> new_ratings Glicko2_types.rate_result

val update_player_after_not_player_in_rating_period : player -> player_result