Creating Custom Iterators using C++20 Concepts

Using C++20 Concepts with Custom Iterators

How do I ensure my custom iterator satisfies C++20 iterator concepts?

Abstract art representing computer programming

To ensure your custom iterator satisfies C++20 iterator concepts, you need to use static_assert to check if your iterator meets the requirements of specific iterator concepts such as std::forward_iterator, std::bidirectional_iterator, etc.

Here’s an example of how to check if a custom iterator satisfies the std::forward_iterator concept:

1#include <iostream>
2#include <string>
3#include <iterator>
4#include <stdexcept>
5#include <concepts>
6
7class Player {
8public:
9  std::string Name;
10};
11
12class Party {
13public:
14  Party(Player A, Player B, Player C)
15    : A{A}, B{B}, C{C} {}
16
17  Player A, B, C;
18
19  class Iterator {
20  public:
21    using iterator_category
22      = std::forward_iterator_tag;
23    using value_type = Player;
24    using difference_type = std::ptrdiff_t;
25    using pointer = Player*;
26    using reference = Player&;
27
28    Iterator() = default;
29    Iterator(Party* ptr, size_t idx) 
30      : Party(ptr), idx(idx) {}
31
32    Player& operator*() const {
33      if (idx == 0) return Party->A;
34      if (idx == 1) return Party->B;
35      if (idx == 2) return Party->C;
36      throw std::out_of_range("Invalid index");
37    }
38
39    Player* operator->() const {
40      return &**this;
41    }
42
43    Iterator& operator++() {
44      ++idx;
45      return *this;
46    }
47
48    Iterator operator++(int) {
49      Iterator tmp = *this;
50      ++(*this);
51      return tmp;
52    }
53
54    bool operator==(const Iterator& other) const {
55      return Party == other.Party && idx == other.idx;
56    }
57
58    bool operator!=(const Iterator& other) const {
59      return !(*this == other);
60    }
61
62  private:
63    size_t idx = 0;
64    Party* Party = nullptr;
65  };
66
67  Iterator begin() { return Iterator(this, 0); }
68  Iterator end() { return Iterator(this, 3); }
69
70  static_assert(std::forward_iterator<Iterator>); 
71};
72
73int main() {
74  Party P{Player{"Anna"},
75    Player{"Bob"}, Player{"Cara"}};
76  
77  for (auto it = P.begin(); it != P.end(); ++it) {
78    std::cout << it->Name << "\n";
79  }
80}

1Anna
2Bob
3Cara

Explanation

static_assert: This line checks if the Iterator class satisfies the std::forward_iterator concept. If it doesn't, the program will not compile, and the compiler will provide helpful error messages indicating what requirements are not met.
Concepts and Requirements: By ensuring your iterator meets the std::forward_iterator concept, you guarantee that it supports all the necessary operations for a forward iterator, such as dereferencing, incrementing, and comparing.

Using concepts helps catch errors at compile time and makes your code more robust and easier to understand. It also ensures compatibility with standard library algorithms that rely on specific iterator categories.

This Question is from the Lesson: