Struct FinalScoreSimulator 

pub struct FinalScoreSimulator;

FinalScoreSimulator struct

A FinalScoreSimulator generates an american football final score given the normalized skill differential (in range [0, 1]) of the home offense and the away defense, and vice versa, the away offense and the home defense.

Implementations

impl FinalScoreSimulator

pub fn new() -> FinalScoreSimulator

Constructor for the FinalScoreSimulator struct

Example

use fbsim_core::game::score::FinalScoreSimulator;

let my_sim = FinalScoreSimulator::new();

pub fn sim( &self, home_team: &impl ScoreSimulatable, away_team: &impl ScoreSimulatable, rng: &mut impl Rng, ) -> Result<FinalScore, String>

Simulates a game by generating a final score result

Example

use fbsim_core::game::score::{FinalScore, FinalScoreSimulator};
use fbsim_core::team::FootballTeam;

let home = FootballTeam::new();
let away = FootballTeam::new();
let sim = FinalScoreSimulator::new();
let mut rng = rand::thread_rng();
let score = sim.sim(&home, &away, &mut rng).unwrap();
println!("{}", score);

Trait Implementations

impl Clone for FinalScoreSimulator

fn clone(&self) -> FinalScoreSimulator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FinalScoreSimulator

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

Formats the value using the given formatter.

impl Default for FinalScoreSimulator

fn default() -> FinalScoreSimulator

Returns the “default value” for a type.

impl PartialEq for FinalScoreSimulator

fn eq(&self, other: &FinalScoreSimulator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FinalScoreSimulator

fn partial_cmp(&self, other: &FinalScoreSimulator) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for FinalScoreSimulator

impl StructuralPartialEq for FinalScoreSimulator