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
183
184
185
186
187
188
189
#![allow(dead_code)]
use rand::thread_rng;
use rand::seq::SliceRandom;

//use crate::cards;
use crate::cards::Card;
use crate::cards::Suit;
use crate::cards::Value;

#[derive(Clone)]
pub struct Hand {
    pub vec: Vec<Card>
}
impl Hand {
    /// returns a hand from a Vec of Card
    pub fn from(vec: Vec<Card>) -> Hand {
        Hand {
            vec: vec
        }
    }

    /// returns a Hand containing a full deck
    /// 
    /// ordered 2, 3, 4, ... J, Q, K, A
    /// Suits ordered Club(♣), Diamond(♦), Heart(♥), Spade(♠)
    pub fn full_deck() -> Hand {
        let mut h = vec![];

        for suit_index in 0..4 {
            for value_index in 0..13 {
                h.push(Card::new(
                    Value::item_from_index(value_index), 
                    Suit::item_from_index(suit_index)
                ))
            }
        }

        Hand::from(h)
    }

    ///Randomizes the order of the hand
    /// 
    /// returns a new value; does not mutate the original value
    pub fn shuffle(&self) -> Hand {
        let mut rng = thread_rng();

        let mut clone = self.vec.clone();
        clone.shuffle(&mut rng);

        Hand::from(
            clone
        )
    }

    /// reverses the hand
    /// i.e. the first index becomes the last index, the second index becomes the second-last index, etc.Hand
    /// 
    /// returns a new value; does not mutate the original value
    pub fn reverse(&self) -> Hand {
        let mut clone = self.vec.clone();
        clone.reverse();

        Hand::from(
            clone
        )
    }

    /// removes the first indexed card in the hand and returns its value
    /// 
    /// mutates the hand; doesn't return a new hand
    /// 
    /// ```
    /// let mut h = Hand::from(
    ///     vec![
    ///         Card::new(Value::Ace, Suit::Spade)
    ///         Card::new(Value::Two, Suit::Spade)
    ///         Card::new(Value::Three, Suit::Spade)
    ///     ]
    /// );
    /// // A♠, 2♠, 3♠
    /// 
    /// let popped = h.pop();
    /// // h == 2♠, 3♠
    /// // popped == A♠
    /// ```
    /// 
    pub fn pop_top(&mut self) -> Card {
        self.vec.reverse();
        let first_card = self.vec.pop().unwrap();
        self.vec.reverse();
        first_card
    }

    /// removes the last indexed card in the hand and returns its value
    /// 
    /// mutates the hand; doesn't return a new hand
    /// 
    /// ```
    /// let mut h = Hand::from(
    ///     vec![
    ///         Card::new(Value::Ace, Suit::Spade)
    ///         Card::new(Value::Two, Suit::Spade)
    ///         Card::new(Value::Three, Suit::Spade)
    ///     ]
    /// );
    /// // A♠, 2♠, 3♠
    /// 
    /// let popped = h.pop();
    /// // h == A♠, 2♠
    /// // popped == 3♠
    /// ```
    /// 
    pub fn pop_bottom(&mut self) -> Card {
        self.vec.pop().unwrap()
    }

    /// Pushes a card to the top of the hand
    /// ```
    /// let mut h = Hand::from(
    ///     vec![
    ///         Card::new(Value::Ace, Suit::Spade)
    ///         Card::new(Value::Two, Suit::Spade)
    ///         Card::new(Value::Three, Suit::Spade)
    ///     ]
    /// );
    /// // A♠, 2♠, 3♠
    /// 
    /// h = h.push(Card::new(Value::King, Suit::Spade))
    /// // K♠, A♠, 2♠, 3♠
    /// ```
    pub fn push_top(&self, card: Card) -> Hand {
        self.reverse().push_bottom(card).reverse()
    }

    /// Pushes a card to the bottom of the hand
    /// ```
    /// let mut h = Hand::from(
    ///     vec![
    ///         Card::new(Value::Ace, Suit::Spade)
    ///         Card::new(Value::Two, Suit::Spade)
    ///         Card::new(Value::Three, Suit::Spade)
    ///     ]
    /// );
    /// // A♠, 2♠, 3♠
    /// 
    /// h = h.push(Card::new(Value::Four, Suit::Spade))
    /// // A♠, 2♠, 3♠, 4♠
    /// ```
    pub fn push_bottom(&self, card: Card) -> Hand {
        let mut clone = self.vec.clone();
        clone.push(card);
        Hand::from(
            clone
        )
    }

    pub fn insert(&self, index: usize, card: Card) -> Hand {
        let mut clone = self.vec.clone();
        clone.insert(index, card);

        Hand::from(
            clone
        )
    }

    /// Stacks a hand on top of another Hand
    /// 
    /// ```
    /// 
    /// ```
    pub fn stack_top(&self, hand: Hand) -> Hand {
        let mut copy = self.clone();
        for card in hand.reverse().vec {
            copy = copy.push_top(card);
        }

        copy
    }
    pub fn stack_bottom(&self, hand: Hand) -> Hand {
        let mut copy = self.clone();

        for card in hand.vec {
            copy = copy.push_bottom(card);
        }

        copy
    }

}