battleship_bot 1.1.5

The game of battleship and a few bot implementations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Stores the Pos struct and pos macro

use rand::distributions::{Distribution, Standard};

use crate::battleship::constants::{NUM_COLS, NUM_ROWS};

/// Saves an x and y for a position on a board
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Pos {
    pub x: usize,
    pub y: usize
}

impl Pos {
    #[doc(hidden)]
    pub fn new(x: usize, y: usize) -> Self {
        Self {
            x, y
        }
    }
}

impl Distribution<Pos> for Standard {
    fn sample<R: rand::prelude::Rng + ?Sized>(&self, rng: &mut R) -> Pos {
        Pos::new(
            rng.gen_range(0..NUM_COLS),
            rng.gen_range(0..NUM_ROWS)
        )
    }
}

/// A macro to create a position from x and y
/// 
/// # Example
/// ```rust
/// use battleship_bot::Pos;
/// use battleship_bot::pos;
/// 
/// let pos = pos!(0, 4);
/// 
/// assert_eq!(pos.x, 0);
/// assert_eq!(pos.y, 4);
/// ```
#[macro_export]
macro_rules! pos {
    ($x:expr, $y:expr) => {
        Pos::new($x, $y)
    };
}