glicko v0.7.0 Glicko.Result
Provides convenience functions for handling a result against an opponent.
Usage
iex> opponent = Player.new_v2
iex> Result.new(opponent, 1.0)
{0.0, 2.014761872416068, 1.0}
iex> Result.new(opponent, :draw) # With shortcut
{0.0, 2.014761872416068, 0.5}Link to this section Summary
Functions
Creates a new result from an opponent and score.
Creates a new result from an opponent rating, opponent rating deviation and score.
Convenience function for accessing an opponent's rating.
Convenience function for accessing an opponent's rating deviation.
Convenience function for accessing the score.
Link to this section Types
Link to this section Functions
new(opponent, score)
new(opponent :: Glicko.Player.t(), score :: score() | score_shortcut()) :: t()
Creates a new result from an opponent and score.
Supports passing either :loss, :draw, or :win as shortcuts.
new(opponent_rating, opponent_rating_deviation, score)
new( Glicko.Player.rating(), Glicko.Player.rating_deviation(), score() | score_shortcut() ) :: t()
Creates a new result from an opponent rating, opponent rating deviation and score.
Values provided for the opponent rating and opponent rating deviation must be v2 based.
Supports passing either :loss, :draw, or :win as shortcuts.
opponent_rating(result)
opponent_rating(result :: t()) :: Glicko.Player.rating()
Convenience function for accessing an opponent's rating.
opponent_rating_deviation(result)
opponent_rating_deviation(result :: t()) :: Glicko.Player.rating_deviation()
Convenience function for accessing an opponent's rating deviation.
Convenience function for accessing the score.