Struct DriveSimulator 

pub struct DriveSimulator { /* private fields */ }

DriveSimulator struct

A DriveSimulator can simulate a drive given a context, returning an updated context and a drive

Implementations

impl DriveSimulator

pub fn new() -> DriveSimulator

Initialize a new drive simulator

Example

use fbsim_core::game::play::DriveSimulator;
 
let my_sim = DriveSimulator::new();

pub fn sim_play( &self, home: &FootballTeam, away: &FootballTeam, context: GameContext, drive: &mut Drive, rng: &mut impl Rng, ) -> Result<GameContext, String>

Simulate the next play of a drive

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::{Drive, DriveSimulator};
use fbsim_core::team::FootballTeam;

// Initialize home & away teams
let my_home = FootballTeam::new();
let my_away = FootballTeam::new();

// Initialize a game context
let mut my_context = GameContext::new();
let mut drive = Drive::new();
 
// Initialize a drive simulator & simulate a drive
let my_sim = DriveSimulator::new();
let mut rng = rand::thread_rng();
my_context = my_sim.sim_play(&my_home, &my_away, my_context, &mut drive, &mut rng).unwrap();

pub fn sim_drive( &self, home: &FootballTeam, away: &FootballTeam, context: GameContext, drive: &mut Drive, rng: &mut impl Rng, ) -> Result<GameContext, String>

Simulate the remaining plays of a drive

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::{Drive, DriveSimulator};
use fbsim_core::team::FootballTeam;

// Initialize home & away teams
let my_home = FootballTeam::new();
let my_away = FootballTeam::new();

// Initialize a game context
let my_context = GameContext::new();
 
// Initialize a drive simulator & simulate a drive
let mut my_drive = Drive::new();
let my_sim = DriveSimulator::new();
let mut rng = rand::thread_rng();
let next_context = my_sim.sim_drive(&my_home, &my_away, my_context, &mut my_drive, &mut rng).unwrap();

pub fn sim( &self, home: &FootballTeam, away: &FootballTeam, context: GameContext, rng: &mut impl Rng, ) -> (Drive, GameContext)

Simulate a new drive

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::DriveSimulator;
use fbsim_core::team::FootballTeam;

// Initialize home & away teams
let my_home = FootballTeam::new();
let my_away = FootballTeam::new();

// Initialize a game context
let my_context = GameContext::new();
 
// Initialize a drive simulator & simulate a drive
let my_sim = DriveSimulator::new();
let mut rng = rand::thread_rng();
let (drive, next_context) = my_sim.sim(&my_home, &my_away, my_context, &mut rng);

Trait Implementations

impl Default for DriveSimulator

fn default() -> Self

Default constructor for the DriveSimulator struct

Example

use fbsim_core::game::play::DriveSimulator;
 
let my_sim = DriveSimulator::default();