MorphoGraphX
MemberIterator.hpp
Go to the documentation of this file.
1 //
2 // This file is part of MorphoGraphX - http://www.MorphoGraphX.org
3 // Copyright (C) 2012-2015 Richard S. Smith and collaborators.
4 //
5 // If you use MorphoGraphX in your work, please cite:
6 // http://dx.doi.org/10.7554/eLife.05864
7 //
8 // MorphoGraphX is free software, and is licensed under under the terms of the
9 // GNU General (GPL) Public License version 2.0, http://www.gnu.org/licenses.
10 //
11 #ifndef MEMBER_ITERATOR_HPP
12 #define MEMBER_ITERATOR_HPP
13 
19 #include <Config.hpp>
20 
21 #include <iterator>
22 
23 namespace mgx {
24 namespace util {
25 template <class Iterator, class Derived> struct BaseIterator {
26  typedef Iterator base_iterator;
30  typedef typename std::iterator_traits<Iterator>::difference_type difference_type;
31 
36  : it()
37  {
38  }
39 
43  BaseIterator(const base_iterator& i)
44  : it(i)
45  {
46  }
47 
51  BaseIterator(const BaseIterator& other)
52  : it(other.it)
53  {
54  }
55 
57 
58 
59  bool operator==(const Derived& other) const {
60  return it == other.it;
61  }
62 
63  bool operator!=(const Derived& other) const {
64  return it != other.it;
65  }
66 
70  Derived& operator=(const Derived& copy)
71  {
72  it = copy.it;
73  return static_cast<Derived&>(*this);
74  }
75 
79  Derived& operator++()
80  {
81  ++it;
82  return static_cast<Derived&>(*this);
83  }
87  Derived& operator++(int)
88  {
89  Derived tmp(*this);
90  ++it;
91  return tmp;
92  }
94 
96 
97 
100  Derived& operator--()
101  {
102  --it;
103  return static_cast<Derived&>(*this);
104  }
108  Derived& operator--(int)
109  {
110  Derived tmp(*this);
111  --it;
112  return tmp;
113  }
115 
117 
118 
121  Derived& operator+=(difference_type n)
122  {
123  it += n;
124  return static_cast<Derived&>(*this);
125  }
126 
130  Derived& operator-=(difference_type n)
131  {
132  it -= n;
133  return static_cast<Derived&>(*this);
134  }
135 
136  bool operator<(const Derived& other) const {
137  return it < other.it;
138  }
139 
140  bool operator>(const Derived& other) const {
141  return it > other.it;
142  }
143 
144  bool operator<=(const Derived& other) const {
145  return it <= other.it;
146  }
147 
148  bool operator>=(const Derived& other) const {
149  return it >= other.it;
150  }
152 
154 
155  friend Derived operator+(const Derived& it, difference_type n)
156  {
157  Derived tmp(it);
158  tmp += n;
159  return tmp;
160  }
161 
162  friend Derived operator+(difference_type n, const Derived& it)
163  {
164  Derived tmp(it);
165  tmp += n;
166  return tmp;
167  }
168 
169  friend Derived operator-(const Derived& it, difference_type n)
170  {
171  Derived tmp(it);
172  tmp -= n;
173  return tmp;
174  }
175 
176  friend Derived operator-(difference_type n, const Derived& it)
177  {
178  Derived tmp(it);
179  tmp -= n;
180  return tmp;
181  }
182 
186  friend difference_type operator-(const Derived& last, const Derived& first) {
187  return last.it - first.it;
188  }
190 
194  base_iterator base() const {
195  return it;
196  }
197 
198 protected:
202  base_iterator it;
203 };
204 
239 template <class Iterator, class T, T std::iterator_traits<Iterator>::value_type::*member, class Reference = T&,
240  class Pointer = T*>
242  : public BaseIterator<Iterator, SelectMemberIterator<Iterator, T, member, Reference, Pointer> > {
250  typedef Iterator base_iterator;
254  typedef typename std::iterator_traits<Iterator>::iterator_category iterator_category;
258  typedef T value_type;
262  typedef typename std::iterator_traits<Iterator>::difference_type difference_type;
266  typedef Reference reference;
270  typedef Pointer pointer;
271 
276  }
277 
281  SelectMemberIterator(const base_iterator& i)
282  : Super(i)
283  {
284  }
285 
290  : Super(other)
291  {
292  }
293 
297  reference operator*() {
298  return (*this->it).*member;
299  }
303  const reference operator*() const {
304  return (*this->it).*member;
305  }
306 
310  pointer operator->() {
311  return &((*this->it).*member);
312  }
316  const pointer operator->() const {
317  return &((*this->it).*member);
318  }
319 };
320 
321 template <typename T> struct remove_pointer;
322 
323 template <typename T> struct remove_pointer<T*> {
324  typedef T type;
325 };
326 
327 template <class Iterator, class T, T remove_pointer<typename std::iterator_traits<Iterator>::value_type>::type::*member,
328  class Reference = T&, class Pointer = T*>
330  : public BaseIterator<Iterator, SelectMemberPointerIterator<Iterator, T, member, Reference, Pointer> > {
338  typedef Iterator base_iterator;
342  typedef typename std::iterator_traits<Iterator>::iterator_category iterator_category;
346  typedef T value_type;
350  typedef typename std::iterator_traits<Iterator>::difference_type difference_type;
354  typedef Reference reference;
358  typedef Pointer pointer;
359 
364  }
365 
369  SelectMemberPointerIterator(const base_iterator& i)
370  : Super(i)
371  {
372  }
373 
378  : Super(other)
379  {
380  }
381 
385  reference operator*() {
386  return (**this->it).*member;
387  }
391  const reference operator*() const {
392  return (**this->it).*member;
393  }
394 
398  pointer operator->() {
399  return &((**this->it).*member);
400  }
404  const pointer operator->() const {
405  return &((**this->it).*member);
406  }
407 };
408 } // namespace util
409 } // namespace mgx
410 #endif
Definition: MemberIterator.hpp:25
Derived & operator--()
Prefix decrement operator.
Definition: MemberIterator.hpp:100
Derived & operator++()
Prefix increment operator.
Definition: MemberIterator.hpp:79
Pointer pointer
Type of a pointer on the values.
Definition: MemberIterator.hpp:358
Definition: MemberIterator.hpp:321
SelectMemberPointerIterator(const base_iterator &i)
Conversion from the base iterator.
Definition: MemberIterator.hpp:369
std::iterator_traits< Iterator >::difference_type difference_type
Type of the difference between two iterators.
Definition: MemberIterator.hpp:30
const reference operator*() const
Constant dereference operator.
Definition: MemberIterator.hpp:391
base_iterator base() const
Direct access to the base iterator.
Definition: MemberIterator.hpp:194
Derived & operator++(int)
Postfix increment operator.
Definition: MemberIterator.hpp:87
BaseIterator(const base_iterator &i)
Conversion from the base iterator.
Definition: MemberIterator.hpp:43
std::iterator_traits< Iterator >::difference_type difference_type
Type of the difference between two iterators.
Definition: MemberIterator.hpp:262
T value_type
Type of the value iterated on.
Definition: MemberIterator.hpp:346
BaseIterator< Iterator, SelectMemberPointerIterator< Iterator, T, member, Reference, Pointer > > Super
Type of the base class.
Definition: MemberIterator.hpp:334
reference operator*()
Dereference operator.
Definition: MemberIterator.hpp:297
std::iterator_traits< Iterator >::difference_type difference_type
Type of the difference between two iterators.
Definition: MemberIterator.hpp:350
SelectMemberPointerIterator(const SelectMemberPointerIterator &other)
Copy constructor.
Definition: MemberIterator.hpp:377
Derived & operator--(int)
Postfix decrement operator.
Definition: MemberIterator.hpp:108
T value_type
Type of the value iterated on.
Definition: MemberIterator.hpp:258
Pointer pointer
Type of a pointer on the values.
Definition: MemberIterator.hpp:270
Iterate over a container of structure, dereferencing only a member of it.
Definition: MemberIterator.hpp:241
SelectMemberIterator(const SelectMemberIterator &other)
Copy constructor.
Definition: MemberIterator.hpp:289
const reference operator*() const
Constant dereference operator.
Definition: MemberIterator.hpp:303
Iterator base_iterator
Type of the underlying iterator.
Definition: MemberIterator.hpp:250
This namespace contains all the API of MorphoGraphX.
Definition: Assert.hpp:26
SelectMemberPointerIterator()
Default constructor.
Definition: MemberIterator.hpp:363
std::iterator_traits< Iterator >::iterator_category iterator_category
Category of the iterator.
Definition: MemberIterator.hpp:254
Reference reference
Type of a reference on the values.
Definition: MemberIterator.hpp:354
pointer operator->()
Pointer-like arrow operator.
Definition: MemberIterator.hpp:310
Derived & operator-=(difference_type n)
In-place random decrement operator.
Definition: MemberIterator.hpp:130
BaseIterator(const BaseIterator &other)
Copy constructor.
Definition: MemberIterator.hpp:51
SelectMemberIterator(const base_iterator &i)
Conversion from the base iterator.
Definition: MemberIterator.hpp:281
BaseIterator< Iterator, SelectMemberIterator< Iterator, T, member, Reference, Pointer > > Super
Type of the base class.
Definition: MemberIterator.hpp:246
reference operator*()
Dereference operator.
Definition: MemberIterator.hpp:385
const pointer operator->() const
Pointer-like constant arrow operator.
Definition: MemberIterator.hpp:404
Definition: MemberIterator.hpp:329
friend difference_type operator-(const Derived &last, const Derived &first)
Distance between two iterators.
Definition: MemberIterator.hpp:186
SelectMemberIterator()
Default constructor.
Definition: MemberIterator.hpp:275
Iterator base_iterator
Type of the underlying iterator.
Definition: MemberIterator.hpp:338
std::iterator_traits< Iterator >::iterator_category iterator_category
Category of the iterator.
Definition: MemberIterator.hpp:342
Reference reference
Type of a reference on the values.
Definition: MemberIterator.hpp:266
Derived & operator=(const Derived &copy)
Assignment operator.
Definition: MemberIterator.hpp:70
BaseIterator()
Default constructor.
Definition: MemberIterator.hpp:35
base_iterator it
Underlying iterator.
Definition: MemberIterator.hpp:202
Derived & operator+=(difference_type n)
In-place random increment operator.
Definition: MemberIterator.hpp:121
pointer operator->()
Pointer-like arrow operator.
Definition: MemberIterator.hpp:398
const pointer operator->() const
Pointer-like constant arrow operator.
Definition: MemberIterator.hpp:316