Implemented iterator for DSList

Author: Levi-B4

.github/workflows/build.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - DSAdjList
 
 jobs:
   build:

CMakeLists.txt

@@ -28,12 +28,17 @@ set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 add_executable(${EXE_NAME} ./main.cpp
-	DSString/dsstring.h DSString/dsstring.cpp 
 	./catch.hpp
         ./test.cpp
+
+        DSString/dsstring.h DSString/dsstring.cpp
+
         DSVector/dsvector.h
-        DSStack/dsstack.h
+
         DSDoublyLL/dsnode.h
         DSDoublyLL/dsdoublyll.h
 
-        DSAdjList/dsadjlist.h )
+        DSStack/dsstack.h
+
+        DSAdjList/dsadjlist.h
+)

DSDoublyLL/dsdoublyll.h

@@ -5,6 +5,67 @@
 
 template <class T>
 class DSDoublyLL{
+private:
+    /**
+     * @brief The iterator struct - iterator for the vector class
+     */
+    struct iterator{
+    public:
+        /**
+         * @brief iterator - constructor
+         * @param ptr - pointer to start iteration from
+         */
+        iterator(DSNode<T>* ptr): ptr(ptr){}
+
+        /**
+         * @brief operator * - dereferences pointer
+         * @return - reference of the class T at the pointer's location
+         */
+        T& operator*(){
+            return ptr->data;
+        }
+
+        /**
+         * @brief operator ++ - iterates to next pointer
+         * @return this iterator after iteration
+         */
+        iterator operator++(){
+            ptr = ptr->next;
+            return *this;
+        }
+
+        /**
+         * @brief operator ++
+         * @return a reference to an iterator before iteration
+         */
+        iterator operator++(int){
+            iterator tmp = *this;
+            ptr = ptr->next;
+            return tmp;
+        }
+
+        /**
+         * @brief operator == compares if two iterators are equal
+         * @param a - first iterator to compare
+         * @param b - second iterator to compare
+         * @return true if the two iterators are equal
+         */
+        friend bool operator==(const iterator& a, const iterator& b){
+            return a.ptr == b.ptr;
+        }
+
+        /**
+         * @brief operator != compares if two iterators are equal
+         * @param a - first iterator to compare
+         * @param b - second iterator to compare
+         * @return true if the two iterators are not equal
+         */
+        friend bool operator!=(const iterator& a, const iterator& b){
+            return a.ptr != b.ptr;
+        }
+    private:
+        DSNode<T>* ptr;
+    };
 public:
     /**
      * @brief DSDoublyLL - default constructor
@@ -119,6 +180,14 @@ class DSDoublyLL{
      */
     ~DSDoublyLL();
 
+    inline iterator begin(){
+        return iterator(head);
+    };
+
+    inline iterator end(){
+        return iterator(nullptr);
+    }
+
 private:
     DSNode<T>* head = nullptr;
     DSNode<T>* tail = nullptr;

test.cpp

@@ -388,6 +388,16 @@ TEST_CASE("Data_Structures_Doubly_Linked_List", "[Doubly_Linked_List][Data_Struc
 
         numList3 = numList1 + numList2;
     }
+
+    SECTION("Iteration"){
+        for(auto& it : numList1){
+            it += 3;
+        }
+
+        REQUIRE(numList1 == numList2);
+
+        numList1 = numList1Copy;
+    }
 }
 
 /*