ripin 0.1.2

A library that handle Reverse Polish notated expressions, compiles, and evaluate them.
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
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

/// A growable stack implementing `push/pop` actions.
///
/// ```
/// use ripin::Stack;
///
/// let mut stack = Stack::new();
///
/// stack.push(3);
/// stack.push(4);
/// stack.push(10);
/// assert_eq!(stack.len(), 3);
///
/// assert_eq!(stack.pop(), Some(10));
/// assert_eq!(stack.len(), 2);
/// ```
pub struct Stack<T>(Vec<T>);

impl<T> Stack<T> {
    /// Creates an empty VecDeque.
    ///
    /// # Examples
    ///
    /// ```
    /// use ripin::Stack;
    ///
    /// let mut stack: Stack<i32> = Stack::new();
    /// ```
    #[inline]
    pub fn new() -> Stack<T> {
        Stack(Vec::new())
    }

    /// Creates an empty VecDeque with space for at least n elements.
    ///
    /// # Examples
    ///
    /// ```
    /// use ripin::Stack;
    ///
    /// let mut stack: Stack<i32> = Stack::with_capacity(10);
    /// ```
    #[inline]
    pub fn with_capacity(capacity: usize) -> Stack<T> {
        Stack(Vec::with_capacity(capacity))
    }

    /// Returns the number of elements in the set.
    ///
    /// # Examples
    ///
    /// ```
    /// use ripin::Stack;
    ///
    /// let mut stack = Stack::new();
    /// stack.push(3);
    /// assert_eq!(stack.len(), 1);
    /// ```
    #[inline]
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Returns true if the set contains no elements.
    ///
    /// # Examples
    ///
    /// ```
    /// use ripin::Stack;
    ///
    /// let mut stack = Stack::new();
    /// assert_eq!(stack.is_empty(), true);
    /// stack.push(3);
    /// assert_eq!(stack.is_empty(), false);
    /// ```
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Appends an element to the back of the stack.
    ///
    /// # Panics
    ///
    /// Panics if the number of elements in the stack overflows a usize.
    ///
    /// # Examples
    ///
    /// ```
    /// use ripin::Stack;
    ///
    /// let mut stack = Stack::new();
    /// stack.push(3);
    /// assert_eq!(stack.pop(), Some(3));
    /// assert_eq!(stack.pop(), None);
    /// ```
    #[inline]
    pub fn push(&mut self, value: T) {
        self.0.push(value)
    }

    /// Removes the last element from the stack and returns it,
    /// or `None` if it is empty.
    ///
    /// # Examples
    ///
    /// ```
    /// use ripin::Stack;
    ///
    /// let mut stack = Stack::new();
    /// stack.push(3);
    /// stack.push(2);
    /// assert_eq!(stack.pop(), Some(2));
    /// assert_eq!(stack.pop(), Some(3));
    /// assert_eq!(stack.pop(), None);
    /// ```
    #[inline]
    pub fn pop(&mut self) -> Option<T> {
        self.0.pop()
    }
}