Data-Structures/iterator.h at master · batabek/Data-Structures · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#ifndef ITERATOR
#define ITERATOR

/**
 * @brief
 * Abstract Base class for iterators
 *
 * @tparam T Type of the iterator
 */
template <class T>
class Iterator {
 public:

  /**
   * @brief Iterator dtor
   *
   */
  virtual ~Iterator() { }

  /**
   * @brief overloaded increment operator
   *
   * @return Iterator<T>&
   */
  virtual Iterator<T>& operator++() = 0;

  /**
   * @brief overloaded increment operator
   *
   * @return Iterator<T>&
   */
  virtual Iterator<T>& operator++(int) = 0;

  /**
   * @brief overloaded equality operator
   *
   * @param other istance of the other iterator
   * @return true if both iterators are same
   * @return false otherwise
   */
  virtual bool operator==(Iterator<T>& other) const = 0;

  /**
   * @brief overloaded not equality operator
   *
   * @param other instance of the other iterator
   * @return true if both instances are same
   * @return false otherwise
   */
  virtual bool operator!=(Iterator<T>& other) const = 0;

  /**
   * @brief overloaded Dereference(*) operator
   *
   * @return T& type of the iterator
   */
  virtual T& operator*() const = 0;
};

#endif