algods 0.1.0

A collection of data structures and algorithms
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
121
122
123
124
125
126
127
128
129

#[cfg(test)]
mod unit_test;

use std::collections::LinkedList;

/// Implementation of deques with the standard library
/// # Examples
/// ```
/// use algods::data_structure::Deque;
/// let mut deque = Deque::new();
/// assert_eq!(deque.len(), 0);
/// deque.add_first(0);
/// deque.add_last(1);
/// deque.add_first(2);
/// assert_eq!(deque.len(), 3);
/// assert_eq!(deque.remove_last(), Some(1));
/// assert_eq!(deque.remove_first(), Some(2));
/// assert_eq!(deque.len(), 1);
/// ```
#[derive(Default, Clone, Debug)]
pub struct Deque<T> {
    list: LinkedList<T>,
}

impl<T> Deque<T> {
    /// Creates an empty deque instance.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let deque = Deque::<usize>::new();
    /// assert_eq!(deque.len(), 0);
    /// ```
    pub fn new() -> Self {
        Self {
            list: LinkedList::new(),
        }
    }

    /// Creates a new deque with an initial object.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let deque = Deque::init("deque");
    /// assert_eq!(deque.len(), 1);
    /// ```
    pub fn init(s: T) -> Self {
        let mut res = Self {
            list: LinkedList::new(),
        };
        res.add_first(s);
        res
    }

    /// Tests whether or not the deque is empty.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let deque = Deque::<usize>::new();
    /// assert!(deque.is_empty());
    /// ```
    pub fn is_empty(&self) -> bool {
        self.list.is_empty()
    }

    /// Gives the number of objects in the deque.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let deque = Deque::<isize>::new();
    /// assert_eq!(deque.len(),0);
    /// ```
    pub fn len(&self) -> usize {
        self.list.len()
    }

    /// Inserts an object at the beginning of the deque.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let mut deque = Deque::<isize>::new();
    /// deque.add_first(-1);
    /// deque.add_first(-2);
    /// assert_eq!(deque.remove_first(), Some(-2));
    /// ```
    pub fn add_first(&mut self, elt: T) {
        self.list.push_front(elt)
    }

    /// Inserts an object at the end of the deque.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let mut deque = Deque::<isize>::new();
    /// deque.add_last(-1);
    /// deque.add_last(-2);
    /// assert_eq!(deque.remove_first(), Some(-1));
    /// ```
    pub fn add_last(&mut self, elt: T) {
        self.list.push_back(elt)
    }

    /// Deletes and returns the first object in the deque, if any.
    /// Returns `None` otherwise.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let mut deque = Deque::init(1);
    /// deque.add_last(0);
    /// deque.add_last(1);
    /// assert_eq!(deque.remove_first(), Some(1));
    /// ```
    pub fn remove_first(&mut self) -> Option<T> {
        self.list.pop_front()
    }

    /// Deletes and returns the last object in the deque, if any.
    /// Returns `None` otherwise.
    /// # Example
    /// ```
    /// use algods::data_structure::Deque;
    /// let mut deque = Deque::init(1);
    /// deque.add_last(0);
    /// deque.add_last(1);
    /// assert_eq!(deque.remove_last(), Some(1));
    /// ```
    pub fn remove_last(&mut self) -> Option<T> {
        self.list.pop_back()
    }
}