added iterators to bst class

src/classes/tree/avl_tree.h

@@ -325,7 +325,7 @@ template <typename T> class avl_tree<T>::Iterator {
   /**
    * @brief = operator for Iterator type
    *
-   * @param current smart pointer of type node
+   * @param index the current index
    * @return Iterator&
    */
   Iterator &operator=(int64_t index) {
@@ -360,7 +360,7 @@ template <typename T> class avl_tree<T>::Iterator {
    * @brief operator != for type Iterator
    *
    * @param it const Iterator
-   * @return true if curr_root == it.curr_root
+   * @return true if index == it.index
    * @return false otherwise
    */
   bool operator!=(const Iterator &it) { return index != it.index; }

src/classes/tree/bst.h

@@ -48,6 +48,28 @@ template <typename T> class bst {
    */
   void remove(T key) { root = __remove(root, key); }
 
+  class Iterator;
+
+  /**
+   * @brief pointer that points to begin
+   *
+   * @return Iterator
+   */
+  Iterator begin() {
+    std::vector<T> ino = this->inorder();
+    return Iterator(0, ino);
+  }
+
+  /**
+   * @brief pointer that points to end
+   *
+   * @return Iterator
+   */
+  Iterator end() {
+    std::vector<T> ino = this->inorder();
+    return Iterator(ino.size(), ino);
+  }
+
   /**
    *@brief inorder function.
    *@returns vector<T>, the elements inorder.
@@ -240,4 +262,72 @@ template <typename T> class bst {
   }
 };
 
+/**
+ * @brief Iterator class
+ */
+template <typename T> class bst<T>::Iterator {
+private:
+  std::vector<T> elements;
+  int64_t index;
+
+public:
+  /**
+   * @brief Construct a new Iterator object
+   *
+   * @param els vector<T> - the elements in inorder fashion
+   */
+  explicit Iterator(const int64_t &index, std::vector<T> &els) noexcept
+      : index(index), elements(els) {}
+
+  /**
+   * @brief = operator for Iterator type
+   *
+   * @param index the current index
+   * @return Iterator&
+   */
+  Iterator &operator=(int64_t index) {
+    this->index = index;
+    return *(this);
+  }
+
+  /**
+   * @brief operator ++ for type Iterator
+   *
+   * @return Iterator&
+   */
+  Iterator &operator++() {
+    if (this->index < elements.size()) {
+      this->index++;
+    }
+    return *(this);
+  }
+
+  /**
+   * @brief operator ++ for type Iterator
+   *
+   * @return Iterator
+   */
+  Iterator operator++(int) {
+    Iterator it = *this;
+    ++*(this);
+    return it;
+  }
+
+  /**
+   * @brief operator != for type Iterator
+   *
+   * @param it const Iterator
+   * @return true if index == it.index
+   * @return false otherwise
+   */
+  bool operator!=(const Iterator &it) { return index != it.index; }
+
+  /**
+   * @brief operator * for type Iterator
+   *
+   * @return T the value of the node
+   */
+  T operator*() { return elements[index]; }
+};
+
 #endif

tests/tree/bst.cc

@@ -85,3 +85,14 @@ TEST_CASE("checking postorder") {
   std::vector<char> post = {'b', 'a', 'w', 'g'};
   REQUIRE(b.postorder() == post);
 }
+
+TEST_CASE("checking iterators") {
+  bst<int> b({5, 3, -10, 4, 15, 20});
+  std::vector<int> els = b.inorder();
+  std::vector<int> check;
+  for (auto it = b.begin(); it != b.end(); it++) {
+    check.push_back(*(it));
+  }
+
+  REQUIRE(els == check);
+}