Struct WhrBuilder

pub struct WhrBuilder<P> { /* private fields */ }

Builder API for Whr, with easy ways to add input data and set the number of iterations for refinement.

Implementations

impl<P> WhrBuilder<P>

where P: Hash + Eq + Clone,

pub fn new() -> Self

Creates a new default builder.

pub fn build(self) -> Whr<P>

Uses the currently inputted parameters to compute ratings. This does not consume the builder.

pub fn with_game( self, p1: P, p2: P, winner: Option<P>, time: usize, handicap: Option<EloRating>, ) -> Self

Adds a game record to the builder.

pub fn with_games( self, games: impl Iterator<Item = (P, P, Option<P>, usize, Option<EloRating>)>, ) -> Self

Adds multiple games to the builder at once.

pub fn with_iterations(self, iterations: u32) -> Self

Sets the number of iterations. By default, the algorithm iterates until a given precision (1e-3 by default) is reached.

Note that passing a value of 0 is the same as indicating that the algorithm should keep the default behavior.

pub fn with_epsilon(self, epsilon: f64) -> Self

Sets the precision at which the algorithm should consider ratings to be stabilized. By default, this value is 1e-3.

pub fn with_maximum_duration(self, duration: Duration) -> Self

Specifies a maximum duration for the algorithm to run.

pub fn with_batch_size(self, size: u32) -> Self

Specifies how many iterations to perform as a batch before checking for stop conditions such as time or convergence. By default, checks are performed after every batch of 10 iterations.

Note that passing a batch size of 0 will set the batch size to 1.

pub fn with_w2(self, w2: f64) -> Self

Sets the w2 parameter, responsible for the variability of ratings over time.

pub fn with_virtual_games(self, virtual_games: u32) -> Self

Sets the number of virtual games to stabilize ratings.

pub fn compute_normalizing_terms(&mut self, player: usize)

Computes the normalizing terms for all sets of games/players.

Trait Implementations

impl<P: Clone> Clone for WhrBuilder<P>

fn clone(&self) -> WhrBuilder<P>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P> Default for WhrBuilder<P>

fn default() -> Self

Returns the “default value” for a type.