From 426ecd03f1797d65134389c2acb44f07054ada83 Mon Sep 17 00:00:00 2001
From: shoniavika <48753228+shoniavika@users.noreply.github.com>
Date: Sun, 19 Jul 2020 01:01:03 +0400
Subject: [PATCH] Added queue implementation using two stacks (#953)

* added queue implementation using 2 stacks

* added empty queue error handling

* added empty queue error handling

* updated format

* deleted macro

* added documentation

* updated documentation, new func for testing

* added copyright

* documented queue class

* made queue a generic one

* handles lvalue error & added consts

* added namespace
---
 data_structures/queue_using_two_stacks.cpp | 144 +++++++++++++++++++++
 1 file changed, 144 insertions(+)
 create mode 100644 data_structures/queue_using_two_stacks.cpp

diff --git a/data_structures/queue_using_two_stacks.cpp b/data_structures/queue_using_two_stacks.cpp
new file mode 100644
index 000000000..a09644686
--- /dev/null
+++ b/data_structures/queue_using_two_stacks.cpp
@@ -0,0 +1,144 @@
+/**
+ * @author [shoniavika](https://github.com/shoniavika)
+ * @file
+ *
+ * Implementation of a Queue using two Stacks.
+ */
+
+#include <cassert>
+#include <iostream>
+#include <stack>
+
+namespace {
+/**
+ * @brief Queue data structure. Stores elements in FIFO
+ * (first-in-first-out) manner.
+ * @tparam T datatype to store in the queue
+ */
+template <typename T>
+class MyQueue {
+ private:
+    std::stack<T> s1, s2;
+
+ public:
+    /**
+     * Constructor for queue.
+     */
+    MyQueue() = default;
+
+    /**
+     * Pushes x to the back of queue.
+     */
+    void push(T x);
+
+    /**
+     * Removes an element from the front of the queue.
+     */
+    const T& pop();
+
+    /**
+     * Returns first element, without removing it.
+     */
+    const T& peek() const;
+
+    /**
+     * Returns whether the queue is empty.
+     */
+    bool empty() const;
+};
+
+/**
+ * Appends element to the end of the queue
+ */
+template <typename T>
+void MyQueue<T>::push(T x) {
+    while (!s2.empty()) {
+        s1.push(s2.top());
+        s2.pop();
+    }
+    s2.push(x);
+    while (!s1.empty()) {
+        s2.push(s1.top());
+        s1.pop();
+    }
+}
+
+/**
+ * Removes element from the front of the queue
+ */
+template <typename T>
+const T& MyQueue<T>::pop() {
+    const T& temp = MyQueue::peek();
+    s2.pop();
+    return temp;
+}
+
+/**
+ * Returns element in the front.
+ * Does not remove it.
+ */
+template <typename T>
+const T& MyQueue<T>::peek() const {
+    if (!empty()) {
+        return s2.top();
+    }
+    std::cerr << "Queue is empty" << std::endl;
+    exit(0);
+}
+
+/**
+ * Checks whether a queue is empty
+ */
+template <typename T>
+bool MyQueue<T>::empty() const {
+    return s2.empty() && s1.empty();
+}
+}  // namespace
+
+/**
+ * Testing function
+ */
+void queue_test() {
+    MyQueue<int> que;
+    std::cout << "Test #1\n";
+    que.push(2);
+    que.push(5);
+    que.push(0);
+    assert(que.peek() == 2);
+    assert(que.pop() == 2);
+    assert(que.peek() == 5);
+    assert(que.pop() == 5);
+    assert(que.peek() == 0);
+    assert(que.pop() == 0);
+    assert(que.empty() == true);
+    std::cout << "PASSED\n";
+
+    std::cout << "Test #2\n";
+    que.push(-1);
+    assert(que.empty() == false);
+    assert(que.peek() == -1);
+    assert(que.pop() == -1);
+    std::cout << "PASSED\n";
+
+    MyQueue<double> que2;
+    std::cout << "Test #3\n";
+    que2.push(2.31223);
+    que2.push(3.1415926);
+    que2.push(2.92);
+
+    assert(que2.peek() == 2.31223);
+    assert(que2.pop() == 2.31223);
+    assert(que2.peek() == 3.1415926);
+    assert(que2.pop() == 3.1415926);
+    assert(que2.peek() == 2.92);
+    assert(que2.pop() == 2.92);
+    std::cout << "PASSED\n";
+}
+
+/**
+ * Main function, calls testing function
+ */
+int main() {
+    queue_test();
+    return 0;
+}