logo
  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

/// A stack-like data structure implemented through a `Vec`.
///
/// The name "stack" for this type of structure comes from the analogy to a set
/// of physical items stacked on top of each other, which makes it easy to take
/// an item off the top of the stack, while getting to an item deeper in the
/// stack may require taking off multiple other items first.
///
/// Considered as a linear data structure, or more abstractly a sequential
/// collection, the push and pop operations occur only at one end of the
/// structure, referred to as the top of the stack.
///
/// References:
///
/// * [Stack (abstract data type)](https://en.wikipedia.org/wiki/Stack_\(abstract_data_type\))
/// * [Big-O Algorithm Complexity Cheat Sheet](http://bigocheatsheet.com/)
// ANCHOR: struct
pub struct Stack<T> {
    maxsize: usize,
    items: Vec<T>,
}
// ANCHOR_END: struct

impl<T> Stack<T> {
    /// Initialize a stack of certain capacity.
    ///
    /// # Parameters
    ///
    /// * `maxsize`: Capacity of the collection. It limits how many items can
    /// be stored.
    // ANCHOR: with_capacity
    pub fn with_capacity(maxsize: usize) -> Self {
        Self {
            maxsize,
            items: Vec::with_capacity(maxsize),
        }
    }
    // ANCHOR_END: with_capacity

    /// Removes the most recently added element that was not yet removed.
    ///
    /// # Returns
    ///
    /// Returns the most recently added item. If nothing was added, `None` will be returned.
    ///
    /// # Complexity
    ///
    /// Constant.
    // ANCHOR: pop
    pub fn pop(&mut self) -> Option<T> {
        self.items.pop()
    }
    // ANCHOR_END: pop

    /// Adds an element to the collection.
    ///
    /// # Returns
    ///
    /// Returns `true` if the collection has space left and item is
    /// successfully added, otherwise returns `false`.
    ///
    /// # Complexity
    ///
    /// Constant.
    // ANCHOR: push
    pub fn push(&mut self, item: T) -> bool {
        if self.items.len() == self.maxsize {
            return false;
        }
        self.items.push(item);
        return true;
    }
    // ANCHOR_END: push

    /// # Returns
    ///
    /// Returns the size of collection, indicates how many items are added in
    /// the collection.
    ///
    /// # Note
    ///
    /// Size and capacity are different concepts.
    /// Capacity limits how many items can be stored, while size indicates how
    /// many items is currently stored.
    // ANCHOR: size
    pub fn size(&self) -> usize {
        self.items.len()
    }
    // ANCHOR_END: size

    /// Peeks the last element added without tampering the collection.
    ///
    /// # Returns
    ///
    /// Returns the most recently added item. If nothing was added, `None` will
    /// be returned.
    // ANCHOR: peek
    pub fn peek(&self) -> Option<&T> {
        self.items.last()
    }
    // ANCHOR_END: peek
}

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

    #[test]
    fn new_with_capacity() {
        let stack: Stack<u32> = Stack::with_capacity(10);
        assert_eq!(10, stack.items.capacity());
    }

    #[test]
    fn pop() {
        let mut stack = Stack::with_capacity(1);
        stack.push(1);
        assert_eq!(Some(1), stack.pop());
        assert_eq!(None, stack.pop());
    }

    #[test]
    fn push() {
        let mut stack = Stack::with_capacity(1);
        stack.push(32);
        assert_eq!(Some(&32), stack.peek());
        assert_eq!(1, stack.size());
    }

    #[test]
    fn push_maxsize() {
        let mut stack = Stack::with_capacity(1);
        assert_eq!(true, stack.push(1));
        assert_eq!(Some(&1), stack.peek());
        assert_eq!(false, stack.push(2));
    }

    #[test]
    fn size() {
        let mut stack = Stack::with_capacity(1);
        assert_eq!(0, stack.size());
        stack.push(1);
        assert_eq!(1, stack.size());
    }
}