Struct battleship_bot::Battleship

pub struct Battleship { /* private fields */ }

Handles the games

Implementations

impl Battleship

pub fn new( player1_place_fn: fn() -> BoatMap, player2_place_fn: fn() -> BoatMap, player1_shoot_fn: fn(_: Pos, _: ShotMap) -> (Pos, bool), player2_shoot_fn: fn(_: Pos, _: ShotMap) -> (Pos, bool) ) -> Self

This function is used to create the game. The parameters are basically what they are named.

player1_place_fn and player2_place_fn can both be any function from place.

player1_shoot_fn and player2_shoot_fn can both be any function from shoot.

pub fn play_and_record_game(&mut self) -> Recording

This function allows you to record a game and get data from it. It will return a Recording struct, which has a lot of handy features.

Example

use battleship_bot::Battleship;
use battleship_bot::{place, shoot};
 
let mut battleship = Battleship::new(
    place::random,
    place::random,
 
    shoot::random,
    shoot::grid_and_destroy,
);
 
let recording = battleship.play_and_record_game();
 
// Small chance this assertion will fail, but it's really small
assert_ne!(recording.player1_boats, recording.player2_boats);
 
println!("Player {} won!", recording.winner);

pub fn play_games(&mut self, num_games: usize) -> (usize, usize)

This function allows you to have the bots play many games. The only parameter is a usize, and that is the number of games the bots will play agains each other. It will return a tuple of player 1 wins and player 2 wins, respectively.

Example

use battleship_bot::Battleship;
use battleship_bot::{place, shoot};
 
let mut battleship = Battleship::new(
    place::random,
    place::random,
 
    shoot::random,
    shoot::grid_and_destroy,
);
 
// When playing multiple games, it will return a tuple of player 1 wins and player 2 wins
let (p1_wins, p2_wins) = battleship.play_games(1000);
 
assert!(p2_wins > p1_wins);

pub fn save_games( place_fns: Vec<(&'static str, fn() -> BoatMap)>, shoot_fns: Vec<(&'static str, fn(_: Pos, _: ShotMap) -> (Pos, bool))>, games_per_comb: usize, filename: &str )

Saves games from the inputs

Saves games against all possible combinations of place_fns and shoot_fns. It runs games_per_comb for each combination of place_fns and shoot_fns. After all the games it stores the data in filename, which is a csv file.

Trait Implementations

impl Clone for Battleship

fn clone(&self) -> Battleship

Returns a copy of the value.

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

Performs copy-assignment from source.