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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
use std::str::FromStr;

use crate::{Error, BOARD_SIZE};

/// Describe a rank (row) on a chess board.
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug)]
#[repr(u8)]
pub enum Rank {
    First,
    Second,
    Third,
    Fourth,
    Fifth,
    Sixth,
    Seventh,
    Eighth,
}

/// Numbers of [`Rank`].
pub const NUM_RANKS: usize = BOARD_SIZE.1 as usize;

/// Enumerate all ranks.
pub const ALL_RANKS: [Rank; NUM_RANKS] = [
    Rank::First,
    Rank::Second,
    Rank::Third,
    Rank::Fourth,
    Rank::Fifth,
    Rank::Sixth,
    Rank::Seventh,
    Rank::Eighth,
];

impl Rank {
    /// Gets a [`Rank`] from an integer index.
    ///
    /// > **Note**: If index is not in the range 0..=7, wrap around.
    #[inline]
    pub fn new(index: usize) -> Self {
        ALL_RANKS[index % NUM_RANKS]
    }

    /// Convert this [`Rank`] into a [`usize`].
    #[inline]
    pub fn to_index(&self) -> usize {
        *self as usize
    }

    /// Go one rank up.
    ///
    /// > **Note**: If impossible, wrap around.
    #[inline]
    pub fn up(&self) -> Self {
        Rank::new(self.to_index() + 1)
    }

    /// Go one rank down.
    ///
    /// > **Note**: If impossible, wrap around.
    #[inline]
    pub fn down(&self) -> Self {
        let idx = self.to_index();
        match idx {
            0 => Rank::new(NUM_RANKS - 1),
            _ => Rank::new(idx - 1),
        }
    }

    /// Distance between two [`Rank`].
    #[inline]
    pub fn distance(&self, other: Rank) -> u32 {
        self.to_index().abs_diff(other.to_index()) as u32
    }

    /// Verify if the [`Rank`] is between two other (i.e. lower <= self <= upper).
    ///
    /// Assume that lower_bound <= upper_bound.
    #[inline]
    pub fn between(&self, lower_bound: Rank, upper_bound: Rank) -> bool {
        lower_bound <= *self && *self <= upper_bound
    }
}

impl FromStr for Rank {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        if s.is_empty() {
            return Err(Error::InvalidRank);
        }
        match s.chars().next().unwrap() {
            '1' => Ok(Rank::First),
            '2' => Ok(Rank::Second),
            '3' => Ok(Rank::Third),
            '4' => Ok(Rank::Fourth),
            '5' => Ok(Rank::Fifth),
            '6' => Ok(Rank::Sixth),
            '7' => Ok(Rank::Seventh),
            '8' => Ok(Rank::Eighth),
            _ => Err(Error::InvalidRank),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn to_index() {
        assert_eq!(Rank::First.to_index(), 0);
        assert_eq!(Rank::Second.to_index(), 1);
        assert_eq!(Rank::Third.to_index(), 2);
        assert_eq!(Rank::Fourth.to_index(), 3);
        assert_eq!(Rank::Fifth.to_index(), 4);
        assert_eq!(Rank::Sixth.to_index(), 5);
        assert_eq!(Rank::Seventh.to_index(), 6);
        assert_eq!(Rank::Eighth.to_index(), 7);
    }

    #[test]
    fn up() {
        assert_eq!(Rank::First.up(), Rank::Second);
        assert_eq!(Rank::Second.up(), Rank::Third);
        assert_eq!(Rank::Third.up(), Rank::Fourth);
        assert_eq!(Rank::Fourth.up(), Rank::Fifth);
        assert_eq!(Rank::Fifth.up(), Rank::Sixth);
        assert_eq!(Rank::Sixth.up(), Rank::Seventh);
        assert_eq!(Rank::Seventh.up(), Rank::Eighth);
        assert_eq!(Rank::Eighth.up(), Rank::First);
    }

    #[test]
    fn down() {
        assert_eq!(Rank::First.down(), Rank::Eighth);
        assert_eq!(Rank::Second.down(), Rank::First);
        assert_eq!(Rank::Third.down(), Rank::Second);
        assert_eq!(Rank::Fourth.down(), Rank::Third);
        assert_eq!(Rank::Fifth.down(), Rank::Fourth);
        assert_eq!(Rank::Sixth.down(), Rank::Fifth);
        assert_eq!(Rank::Seventh.down(), Rank::Sixth);
        assert_eq!(Rank::Eighth.down(), Rank::Seventh);
    }

    #[test]
    fn distance() {
        assert_eq!(Rank::First.distance(Rank::First), 0);
        assert_eq!(Rank::First.distance(Rank::Fourth), 3);
        assert_eq!(Rank::First.distance(Rank::Eighth), 7);
    }

    #[test]
    fn between() {
        // expect true
        assert!(Rank::First.between(Rank::First, Rank::Eighth));
        assert!(Rank::Eighth.between(Rank::First, Rank::Eighth));
        assert!(Rank::First.between(Rank::First, Rank::First));
        // expect false
        assert!(!Rank::First.between(Rank::Second, Rank::Eighth));
        assert!(!Rank::Eighth.between(Rank::First, Rank::Seventh));
        assert!(!Rank::Second.between(Rank::Third, Rank::First));
    }

    #[test]
    fn from_str() {
        assert_eq!(Rank::from_str("1"), Ok(Rank::First));
        assert_eq!(Rank::from_str("2"), Ok(Rank::Second));
        assert_eq!(Rank::from_str("3"), Ok(Rank::Third));
        assert_eq!(Rank::from_str("4"), Ok(Rank::Fourth));
        assert_eq!(Rank::from_str("5"), Ok(Rank::Fifth));
        assert_eq!(Rank::from_str("6"), Ok(Rank::Sixth));
        assert_eq!(Rank::from_str("7"), Ok(Rank::Seventh));
        assert_eq!(Rank::from_str("8"), Ok(Rank::Eighth));
    }

    #[test]
    fn from_str_error() {
        assert_eq!(Rank::from_str(""), Err(Error::InvalidRank));
        assert_eq!(Rank::from_str(" 1"), Err(Error::InvalidRank));
        assert_eq!(Rank::from_str("second"), Err(Error::InvalidRank));
    }
}