Struct GameSimulator 

pub struct GameSimulator { /* private fields */ }

GameSimulator struct

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

Implementations

impl GameSimulator

pub fn new() -> GameSimulator

Constructor for the GameSimulator struct

Example

use fbsim_core::game::play::GameSimulator;

let my_sim = GameSimulator::new();

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

Simulate the next play of a game

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::{GameSimulator, Game};
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 game simulator & simulate a drive
let mut my_game = Game::new();
let my_sim = GameSimulator::new();
let mut rng = rand::thread_rng();
let next_context = my_sim.sim_play(&my_home, &my_away, my_context, &mut my_game, &mut rng).unwrap();

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

Simulate the next drive of a game

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::{GameSimulator, Game};
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 game simulator & simulate a drive
let mut my_game = Game::new();
let my_sim = GameSimulator::new();
let mut rng = rand::thread_rng();
let next_context = my_sim.sim_drive(&my_home, &my_away, my_context, &mut my_game, &mut rng).unwrap();

pub fn sim_game( &self, home: &FootballTeam, away: &FootballTeam, context: GameContext, game: &mut Game, rng: &mut impl Rng, ) -> Result<GameContext, String>

Simulate the remainder of a game

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::{GameSimulator, Game};
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 game simulator and game, simulate the game
let mut my_game = Game::new();
let my_sim = GameSimulator::new();
let mut rng = rand::thread_rng();
let next_context = my_sim.sim_game(&my_home, &my_away, my_context, &mut my_game, &mut rng).unwrap();

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

Simulate a new game

Example

use fbsim_core::game::context::GameContext;
use fbsim_core::game::play::GameSimulator;
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 game simulator & simulate a game
let my_sim = GameSimulator::new();
let mut rng = rand::thread_rng();
let (game, final_context) = my_sim.sim(&my_home, &my_away, my_context, &mut rng).unwrap();

Trait Implementations

impl Default for GameSimulator

fn default() -> Self

Default constructor for the GameSimulator struct

Example

use fbsim_core::game::play::GameSimulator;

let my_sim = GameSimulator::default();