mahjong 0.1.0

Functionality relating to the game of mahjong, particulary riichi mahjong.
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
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

/*!
 * Types that implement pais.
 */

use core::hash::Hash;

/**
 * A suit.
 */
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Shoku {
    Manzu,
    Pinzu,
    Souzu,
}

/**
 * A wind.
 */
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Kazehai {
    Ton,
    Nan,
    Shaa,
    Pei,
}

/**
 * A dragon.
 */
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Sangenpai {
    Chun,
    Haku,
    Hatsu,
}

/**
 * A number tile.
 */
#[derive(Clone, Copy, Debug, Eq)]
pub struct Suupai {
    /**
     * The suit.
     */
    pub shoku: Shoku,

    /**
     * The rank, a number from 1 through 9.
     */
    pub rank: u8,

    /**
     * Whether this tile is a red dora.
     */
    pub akadora: bool,
}

// Manually implement Hash to ignore akadora.
impl Hash for Suupai {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.shoku.hash(state);
        self.rank.hash(state);
    }
}

// Manually implement PartialEq to ignore akadora.
impl PartialEq for Suupai {
    fn eq(&self, other: &Self) -> bool {
        self.shoku == other.shoku && self.rank == other.rank
    }
}

/**
 * An honor tile.
 */
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Jihai {
    Kazehai(Kazehai),
    Sangenpai(Sangenpai),
}

/**
 * A tile.
 */
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Pai {
    Jihai(Jihai),
    Suupai(Suupai),
}