qxLib
base_iterator.h
Go to the documentation of this file.
1 /**
2 
3  @file base_iterator.h
4  @author Khrapov
5  @date 2.12.2023
6  @copyright (c) Nick Khrapov, 2023. All right reserved.
7 
8 **/
9 #pragma once
10 
11 #include <qx/meta/concepts.h>
12 
13 #include <iterator>
14 #include <ranges>
15 
16 namespace qx
17 {
18 
19 /**
20 
21  @class base_iterator
22  @brief Base contiguous iterator with a container pointer and an index
23  @tparam container_t - container satisfying std::ranges::contiguous_range concept
24  @author Khrapov
25  @date 2.12.2023
26 
27 **/
28 template<class container_t>
29 /* requires std::ranges::contiguous_range<container_t> */
31 {
32 public:
33  template<class container_t_, class derived_t_>
34  friend class base_forward_iterator;
35 
36  template<class container_t_, class derived_t_>
37  friend class base_reverse_iterator;
38 
39  using difference_type = typename container_t::difference_type;
40  using size_type = typename container_t::size_type;
41  using value_type = typename container_t::value_type;
42  using pointer = typename container_t::pointer;
43  using const_pointer = typename container_t::const_pointer;
44  using reference = typename container_t::reference;
45  using const_reference = typename container_t::const_reference;
46 
47  using iterator_category = std::contiguous_iterator_tag;
48  using iterator_concept = std::contiguous_iterator_tag;
49 
50 public:
51  constexpr base_iterator() noexcept = default;
52  constexpr base_iterator(container_t* pContainer, size_type nIndex) noexcept
53  : m_nIndex(nIndex)
54  , m_pContainer(pContainer)
55  {
56  }
57  constexpr operator void*() noexcept;
58 
59 protected:
60  constexpr void shift(difference_type nShift) noexcept;
61  constexpr decltype(auto) get(difference_type nShift = 0) const noexcept;
62  constexpr size_type get_index() const noexcept;
63  constexpr auto get_address() const noexcept;
64 
65 private:
66  size_type m_nIndex = 0u;
67  container_t* m_pContainer = nullptr;
68 };
69 
70 /**
71 
72  @class base_forward_iterator
73  @brief Basic contiguous forward iterator, meaning that incrementing an iterator will lead it moving forward
74  @tparam container_t - container satisfying std::ranges::contiguous_range concept
75  @tparam derived_t - derived iterator type
76  @author Khrapov
77  @date 2.12.2023
78 
79 **/
80 template<class container_t, class derived_t>
81 class base_forward_iterator : public base_iterator<container_t>
82 {
84  using decayed_derived_type = std::decay_t<derived_t>;
85 
86 public:
87  using super_type::super_type;
88 
89  template<class iterator_t>
90  requires derived_from_template_c<iterator_t, base_iterator>
91  constexpr typename super_type::difference_type operator-(const iterator_t& r) const noexcept;
92  constexpr bool operator<(const base_forward_iterator& r) const noexcept;
93  constexpr bool operator<=(const base_forward_iterator& r) const noexcept;
94  constexpr bool operator>(const base_forward_iterator& r) const noexcept;
95  constexpr bool operator>=(const base_forward_iterator& r) const noexcept;
96  constexpr bool operator!=(const base_forward_iterator& r) const noexcept;
97  constexpr bool operator==(const base_forward_iterator& r) const noexcept;
98  constexpr decayed_derived_type& operator++() noexcept;
99  constexpr decayed_derived_type& operator--() noexcept;
100  [[nodiscard]] constexpr decayed_derived_type operator++(int) noexcept;
101  [[nodiscard]] constexpr decayed_derived_type operator--(int) noexcept;
102  constexpr decayed_derived_type& operator+=(typename super_type::difference_type n) noexcept;
103  constexpr decayed_derived_type& operator-=(typename super_type::difference_type n) noexcept;
104  constexpr decayed_derived_type operator+(typename super_type::difference_type n) const noexcept;
105  constexpr decayed_derived_type operator-(typename super_type::difference_type n) const noexcept;
106 };
107 
108 template<class iterator_t>
109  requires derived_from_template_c<iterator_t, base_forward_iterator>
110 constexpr iterator_t operator+(typename iterator_t::size_type n, iterator_t it) noexcept;
111 
112 /**
113 
114  @class base_reverse_iterator
115  @brief Basic contiguous reverse iterator, meaning that incrementing an iterator will lead it moving backward
116  @tparam container_t - container satisfying std::ranges::contiguous_range concept
117  @tparam derived_t - derived iterator type
118  @author Khrapov
119  @date 2.12.2023
120 
121 **/
122 template<class container_t, class derived_t>
123 class base_reverse_iterator : public base_iterator<container_t>
124 {
126  using decayed_derived_type = std::decay_t<derived_t>;
127 
128 public:
129  using super_type::super_type;
130 
131  template<class iterator_t>
132  requires derived_from_template_c<iterator_t, base_iterator>
133  constexpr typename super_type::difference_type operator-(const iterator_t& r) const noexcept;
134  // + 1 is necessary, as `m_nIndex = -1 (aka size_type::max)`
135  // may be used as end (past-the-last) element
136  constexpr bool operator<(const base_reverse_iterator& r) const noexcept;
137  constexpr bool operator<=(const base_reverse_iterator& r) const noexcept;
138  constexpr bool operator>(const base_reverse_iterator& r) const noexcept;
139  constexpr bool operator>=(const base_reverse_iterator& r) const noexcept;
140  constexpr bool operator!=(const base_reverse_iterator& r) const noexcept;
141  constexpr bool operator==(const base_reverse_iterator& r) const noexcept;
142  constexpr decayed_derived_type& operator++() noexcept;
143  constexpr decayed_derived_type& operator--() noexcept;
144  [[nodiscard]] constexpr decayed_derived_type operator++(int) noexcept;
145  [[nodiscard]] constexpr decayed_derived_type operator--(int) noexcept;
146  constexpr decayed_derived_type& operator+=(typename super_type::difference_type n) noexcept;
147  constexpr decayed_derived_type& operator-=(typename super_type::difference_type n) noexcept;
148  constexpr decayed_derived_type operator+(typename super_type::difference_type n) const noexcept;
149  constexpr decayed_derived_type operator-(typename super_type::difference_type n) const noexcept;
150 };
151 
152 template<class iterator_t>
153  requires derived_from_template_c<iterator_t, base_reverse_iterator>
154 constexpr iterator_t operator+(typename iterator_t::size_type n, iterator_t it) noexcept;
155 
156 } // namespace qx
157 
Basic contiguous forward iterator, meaning that incrementing an iterator will lead it moving forward.
Definition: base_iterator.h:82
Base contiguous iterator with a container pointer and an index.
Definition: base_iterator.h:31
Basic contiguous reverse iterator, meaning that incrementing an iterator will lead it moving backward...
requires(same_variadic_args_v< args_t... >) const expr auto coalesce(args_t &&... args)
Coalesce function, C# a ?? b analogue.
Definition: coalesce.inl:57