refactor: Deque (#5353)

Author: alxkm

src/main/java/com/thealgorithms/datastructures/queues/Deques.java renamed to src/main/java/com/thealgorithms/datastructures/queues/Deque.java

@@ -1,5 +1,7 @@
 package com.thealgorithms.datastructures.queues;
 
+import java.util.NoSuchElementException;
+
 /**
  * A [deque](https://en.wikipedia.org/wiki/Double-ended_queue) is short for a
  * double ended queue pronounced "deck" and sometimes referred to as a head-tail
@@ -9,67 +11,37 @@
  *
  * @author [Ian Cowan](https://github.com/iccowan)
  */
-public class Deques<T> {
+public class Deque<T> {
 
     /**
      * Node for the deque
      */
-    class DequeNode<S> {
-
-        /**
-         * Value of the node
-         */
+    private static class DequeNode<S> {
         S val;
-
-        /**
-         * Next node in the deque from this node
-         */
         DequeNode<S> next = null;
-
-        /**
-         * Previous node in the deque from this node
-         */
         DequeNode<S> prev = null;
 
-        /**
-         * Constructor
-         */
         DequeNode(S val) {
             this.val = val;
         }
     }
 
-    /**
-     * Head of the deque
-     */
-    DequeNode<T> head = null;
-
-    /**
-     * Tail of the deque
-     */
-    DequeNode<T> tail = null;
-
-    /**
-     * Size of the deque
-     */
-    int size = 0;
+    private DequeNode<T> head = null;
+    private DequeNode<T> tail = null;
+    private int size = 0;
 
     /**
      * Adds the specified value to the head of the deque
      *
      * @param val Value to add to the deque
      */
     public void addFirst(T val) {
-        // Create a new node with the given value
-        DequeNode<T> newNode = new DequeNode<T>(val);
+        DequeNode<T> newNode = new DequeNode<>(val);
 
-        // Add the node
-        if (head == null) {
-            // If the deque is empty, add the node as the head and tail
+        if (isEmpty()) {
             head = newNode;
             tail = newNode;
         } else {
-            // If the deque is not empty, insert the node as the new head
             newNode.next = head;
             head.prev = newNode;
             head = newNode;
@@ -84,54 +56,37 @@ public void addFirst(T val) {
      * @param val Value to add to the deque
      */
     public void addLast(T val) {
-        // Create a new node with the given value
-        DequeNode<T> newNode = new DequeNode<T>(val);
-
-        // Add the node
+        DequeNode<T> newNode = new DequeNode<>(val);
         if (tail == null) {
-            // If the deque is empty, add the node as the head and tail
             head = newNode;
+            tail = newNode;
         } else {
-            // If the deque is not empty, insert the node as the new tail
             newNode.prev = tail;
             tail.next = newNode;
+            tail = newNode;
         }
-        tail = newNode;
-
         size++;
     }
 
     /**
      * Removes and returns the first (head) value in the deque
      *
      * @return the value of the head of the deque
+     * @throws NoSuchElementException if the deque is empty
      */
     public T pollFirst() {
-        // If the head is null, return null
         if (head == null) {
-            return null;
+            throw new NoSuchElementException("Deque is empty");
         }
 
-        // First, let's get the value of the old head
         T oldHeadVal = head.val;
-
-        // Now, let's remove the head
         if (head == tail) {
-            // If there is only one node, remove it
             head = null;
             tail = null;
         } else {
-            // If there is more than one node, fix the references
-            head.next.prev = null;
-            DequeNode<T> oldHead = head;
             head = head.next;
-
-            // Can be considered unnecessary...
-            // Unlinking the old head to make sure there are no random
-            // references possibly affecting garbage collection
-            oldHead.next = null;
+            head.prev = null;
         }
-
         size--;
         return oldHeadVal;
     }
@@ -140,52 +95,41 @@ public T pollFirst() {
      * Removes and returns the last (tail) value in the deque
      *
      * @return the value of the tail of the deque
+     * @throws NoSuchElementException if the deque is empty
      */
     public T pollLast() {
-        // If the tail is null, return null
         if (tail == null) {
-            return null;
+            throw new NoSuchElementException("Deque is empty");
         }
 
-        // Let's get the value of the old tail
         T oldTailVal = tail.val;
-
-        // Now, remove the tail
         if (head == tail) {
-            // If there is only one node, remove it
             head = null;
             tail = null;
         } else {
-            // If there is more than one node, fix the references
-            tail.prev.next = null;
-            DequeNode<T> oldTail = tail;
             tail = tail.prev;
-
-            // Similarly to above, can be considered unnecessary
-            // See `pollFirst()` for explanation
-            oldTail.prev = null;
+            tail.next = null;
         }
-
         size--;
         return oldTailVal;
     }
 
     /**
      * Returns the first (head) value of the deque WITHOUT removing
      *
-     * @return the value of the head of the deque
+     * @return the value of the head of the deque, or null if empty
      */
     public T peekFirst() {
-        return head.val;
+        return head != null ? head.val : null;
     }
 
     /**
      * Returns the last (tail) value of the deque WITHOUT removing
      *
-     * @return the value of the tail of the deque
+     * @return the value of the tail of the deque, or null if empty
      */
     public T peekLast() {
-        return tail.val;
+        return tail != null ? tail.val : null;
     }
 
     /**
@@ -203,7 +147,7 @@ public int size() {
      * @return whether or not the deque is empty
      */
     public boolean isEmpty() {
-        return head == null;
+        return size == 0;
     }
 
     /**
@@ -216,25 +160,21 @@ public boolean isEmpty() {
      */
     @Override
     public String toString() {
-        String dequeString = "Head -> ";
+        StringBuilder dequeString = new StringBuilder("Head -> ");
         DequeNode<T> currNode = head;
         while (currNode != null) {
-            dequeString += currNode.val;
-
+            dequeString.append(currNode.val);
             if (currNode.next != null) {
-                dequeString += " <-> ";
+                dequeString.append(" <-> ");
             }
-
             currNode = currNode.next;
         }
-
-        dequeString += " <- Tail";
-
-        return dequeString;
+        dequeString.append(" <- Tail");
+        return dequeString.toString();
     }
 
     public static void main(String[] args) {
-        Deques<Integer> myDeque = new Deques<Integer>();
+        Deque<Integer> myDeque = new Deque<>();
         for (int i = 0; i < 42; i++) {
             if (i / 42.0 < 0.5) {
                 myDeque.addFirst(i);

src/test/java/com/thealgorithms/datastructures/queues/DequeTest.java

@@ -0,0 +1,90 @@
+package com.thealgorithms.datastructures.queues;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNull;
+
+import java.util.NoSuchElementException;
+import org.junit.jupiter.api.Test;
+
+class DequeTest {
+
+    @Test
+    void testAddFirst() {
+        Deque<Integer> deque = new Deque<>();
+        deque.addFirst(10);
+        assertEquals(10, deque.peekFirst());
+        assertEquals(10, deque.peekLast());
+        assertEquals(1, deque.size());
+    }
+
+    @Test
+    void testAddLast() {
+        Deque<Integer> deque = new Deque<>();
+        deque.addLast(20);
+        assertEquals(20, deque.peekFirst());
+        assertEquals(20, deque.peekLast());
+        assertEquals(1, deque.size());
+    }
+
+    @Test
+    void testPollFirst() {
+        Deque<Integer> deque = new Deque<>();
+        deque.addFirst(10);
+        deque.addLast(20);
+        assertEquals(10, deque.pollFirst());
+        assertEquals(20, deque.peekFirst());
+        assertEquals(1, deque.size());
+    }
+
+    @Test
+    void testPollLast() {
+        Deque<Integer> deque = new Deque<>();
+        deque.addFirst(10);
+        deque.addLast(20);
+        assertEquals(20, deque.pollLast());
+        assertEquals(10, deque.peekLast());
+        assertEquals(1, deque.size());
+    }
+
+    @Test
+    void testIsEmpty() {
+        Deque<Integer> deque = new Deque<>();
+        org.junit.jupiter.api.Assertions.assertTrue(deque.isEmpty());
+        deque.addFirst(10);
+        assertFalse(deque.isEmpty());
+    }
+
+    @Test
+    void testPeekFirstEmpty() {
+        Deque<Integer> deque = new Deque<>();
+        assertNull(deque.peekFirst());
+    }
+
+    @Test
+    void testPeekLastEmpty() {
+        Deque<Integer> deque = new Deque<>();
+        assertNull(deque.peekLast());
+    }
+
+    @Test
+    void testPollFirstEmpty() {
+        Deque<Integer> deque = new Deque<>();
+        org.junit.jupiter.api.Assertions.assertThrows(NoSuchElementException.class, deque::pollFirst);
+    }
+
+    @Test
+    void testPollLastEmpty() {
+        Deque<Integer> deque = new Deque<>();
+        org.junit.jupiter.api.Assertions.assertThrows(NoSuchElementException.class, deque::pollLast);
+    }
+
+    @Test
+    void testToString() {
+        Deque<Integer> deque = new Deque<>();
+        deque.addFirst(10);
+        deque.addLast(20);
+        deque.addFirst(5);
+        assertEquals("Head -> 5 <-> 10 <-> 20 <- Tail", deque.toString());
+    }
+}