PerfCalc

Struct PerfCalc 

Source
pub struct PerfCalc { /* private fields */ }
Expand description

Builder for configuring and running the performance calculation algorithm This builder is used to configure the number of iterations and the convergence threshold. The default settings are:

  • Maximum iterations: 100
  • Convergence threshold: 1e-6

§Example

use nypc_perf::{BattleResult, PerfCalc, Rating};
let mut perf = vec![Rating::new(0.0); 2];
let battles = vec![
    BattleResult {
        i: 0,
        j: 1,
        wij: 2.0,
        wji: 1.0,
    }
];

let calc = PerfCalc::new().max_iters(100).epsilon(1e-6);
calc.run(&mut perf, &battles);

Implementations§

Source§

impl PerfCalc

Source

pub fn new() -> Self

Creates a new PerfCalc with default settings.

The default settings are:

  • Maximum iterations: 100
  • Convergence threshold: 1e-6
Source

pub fn max_iters(self, max_iterations: usize) -> Self

Sets the maximum number of iterations.

Source

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

Sets the convergence threshold.

use nypc_perf::PerfCalc;

let calc = PerfCalc::new().epsilon(1e-6);
Source

pub fn run( self, perf: &mut [Rating], battles: &[BattleResult], ) -> Result<usize, f64>

Runs the iterative algorithm to calculate performance ratings.

§Arguments
  • perf - Current performance rating values
  • battles - Iterator of battle results
§Returns

Ok(iterations) if convergence is reached within max_iterations, or Err(final_error) if not converged.

Trait Implementations§

Source§

impl Clone for PerfCalc

Source§

fn clone(&self) -> PerfCalc

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PerfCalc

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PerfCalc

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Copy for PerfCalc

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.