Update: Added headers for doc test

mefreanzy · Aug 19, 2023 · ee13389 · ee13389
1 parent 067c2b5
commit ee13389
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 8 deletions.
diff --git a/src/data_structure/heap.rs b/src/data_structure/heap.rs
@@ -18,6 +18,7 @@ impl<T: PartialOrd> Heap<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::heap::Heap;
     /// let heap: Heap<i32> = Heap::new();
     /// ```
     pub fn new() -> Self
@@ -32,6 +33,7 @@ impl<T: PartialOrd> Heap<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::heap::Heap;
     /// let mut heap: Heap<i32> = Heap::new();
     /// heap.push(4);
     /// heap.push(5);
@@ -42,6 +44,11 @@ impl<T: PartialOrd> Heap<T>
         self.data.push(element);
     }
 
+    pub fn peek(&self) -> Option<&T>
+    {
+        self.data.get(0)
+    }
+
     pub fn heapify(&mut self, n: usize, i: usize)
     {
         let mut largest = i;
@@ -71,6 +78,7 @@ impl<T: PartialOrd> Heap<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::heap::Heap;
     /// let mut heap: Heap<i32> = Heap::new();
     /// heap.push(4);
     /// heap.push(5);
@@ -98,7 +106,7 @@ impl<T: PartialOrd> Heap<T>
 #[cfg(test)]
 mod test
 {
-    use super::*;
+    use super::Heap;
     fn test_heap()
     {
         let mut heap: Heap<i32> = Heap::new();

diff --git a/src/data_structure/linked_list.rs b/src/data_structure/linked_list.rs
@@ -12,7 +12,7 @@ pub struct List<T>
     len: usize,
 }
 
-impl<T> LinkedList<T>
+impl<T> List<T>
 {
     fn new() -> Self
     {
@@ -59,9 +59,7 @@ impl<T> LinkedList<T>
 #[cfg(test)]
 mod test
 {
-    mod queue;
-    mod stack;
-    mod heap;
+    use super::List as LinkedList;
     #[test]
     fn test_linked_list()
     {

diff --git a/src/data_structure/queue.rs b/src/data_structure/queue.rs
@@ -20,6 +20,7 @@ impl<T> Queue<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::queue::Queue;
     /// let queue: Queue<i32> = Queue::new();
     /// ```
     pub fn new() -> Self
@@ -34,6 +35,7 @@ impl<T> Queue<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::queue::Queue;
     /// let mut queue: Queue<i32> = Queue::new();
     /// queue.enqueue(1);
     /// assert_eq!(queue.peek(), Some(&1));
@@ -49,6 +51,7 @@ impl<T> Queue<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::queue::Queue;
     /// let mut queue: Queue<i32> = Queue::new();
     /// queue.enqueue(1);
     /// let element = queue.dequeue();
@@ -64,6 +67,7 @@ impl<T> Queue<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::queue::Queue;
     /// let mut queue: Queue<i32> = Queue::new();
     /// queue.enqueue(1);
     /// assert!(!queue.is_null());
@@ -79,6 +83,7 @@ impl<T> Queue<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::queue::Queue;
     /// let mut queue: Queue<i32> = Queue::new();
     /// queue.enqueue(1);
     /// assert_eq!(queue.peek(), Some(&1));
@@ -92,7 +97,7 @@ impl<T> Queue<T>
 #[cfg(test)]
 mod test
 {
-    use super::*;
+    use super::Queue;
     fn test_queue()
     {
         let mut queue: Queue<i32> = Queue::new();

diff --git a/src/data_structure/stack.rs b/src/data_structure/stack.rs
@@ -18,6 +18,7 @@ impl<T> Stack<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::stack::Stack;
     /// let stack: Stack<i32> = Stack::new();
     /// ```
     pub fn new() -> Self
@@ -32,9 +33,10 @@ impl<T> Stack<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::stack::Stack;
     /// let mut stack: Stack<i32> = Stack::new();
     /// stack.push(1);
-    /// assert!(!is_null());
+    /// assert!(!stack.is_null());
     /// ```
     pub fn push(&mut self, element: T)
     {
@@ -47,6 +49,7 @@ impl<T> Stack<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::stack::Stack;
     /// let mut stack: Stack<i32> = Stack::new();
     /// stack.push(1);
     /// let element = stack.pop();
@@ -62,6 +65,7 @@ impl<T> Stack<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::stack::Stack;
     /// let mut stack: Stack<i32> = Stack::new();
     /// stack.push(1);
     /// assert!(!stack.is_null());
@@ -77,6 +81,7 @@ impl<T> Stack<T>
     /// # Examples
     ///
     /// ```
+    /// use RustyDSA::data_structure::stack::Stack;
     /// let mut stack: Stack<i32> = Stack::new();
     /// stack.push(1);
     /// assert_eq!(stack.peek(), Some(&1));
@@ -90,7 +95,7 @@ impl<T> Stack<T>
 #[cfg(test)]
 mod test
 {
-    use super::*;
+    use super::Stack;
     #[test]
     fn test_stack()
     {