MorphoGraphX
Forall.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 
60 #ifndef UTIL_FORALL_HPP
61 #define UTIL_FORALL_HPP
62 
63 #include <Config.hpp>
64 
65 #include <iterator>
66 #include <utility>
67 
68 namespace mgx {
69 namespace util {
71 namespace ForAll {
72 struct BaseForwardIter {
73  virtual ~BaseForwardIter() {
74  }
75 };
76 
77 template <typename iterator> struct ForwardIter : public BaseForwardIter {
78  typedef typename std::iterator_traits<iterator>::value_type value_type;
79  typedef typename std::iterator_traits<iterator>::reference reference;
80 
81  ForwardIter(const iterator& fst, const iterator& lst)
82  : it(fst)
83  , end(lst)
84  , brk(0)
85  {
86  }
87 
88  const reference value() const
89  {
90  ++brk;
91  return *it;
92  }
93  bool is_end() const {
94  return (it == end) || brk;
95  }
96  mutable iterator it;
97  iterator end;
98  mutable int brk;
99 };
100 
101 template <typename Pair, typename iterator> inline ForwardIter<iterator> forwardIter(const Pair& range, const iterator*)
102 {
103  return ForwardIter<iterator>(range.first, range.second);
104 }
105 
106 template <typename iterator>
107 inline const ForwardIter<iterator>* castForwardIter(const BaseForwardIter* base, const iterator*)
108 {
109  return static_cast<const ForwardIter<iterator>*>(base);
110 }
111 
112 template <typename T> inline T* pointer(const T&) {
113  return 0;
114 }
115 
116 template <typename Container>
117 std::pair<typename Container::iterator, typename Container::iterator> make_range(Container& cont)
118 {
119  return std::make_pair(cont.begin(), cont.end());
120 }
121 
122 template <typename Container>
123 std::pair<typename Container::const_iterator, typename Container::const_iterator> make_range(const Container& cont)
124 {
125  return std::make_pair(cont.begin(), cont.end());
126 }
127 
128 template <typename Iterator> std::pair<Iterator, Iterator> make_range(const std::pair<Iterator, Iterator>& cont)
129 {
130  return cont;
131 }
132 
133 template <typename Container>
134 std::pair<typename Container::reverse_iterator, typename Container::reverse_iterator>
135 make_reverse_range(Container& cont)
136 {
137  return std::make_pair(cont.rbegin(), cont.rend());
138 }
139 
140 template <typename Container>
141 std::pair<typename Container::const_reverse_iterator, typename Container::const_reverse_iterator>
142 make_reverse_range(const Container& cont)
143 {
144  return std::make_pair(cont.rbegin(), cont.rend());
145 }
146 
147 template <typename Iterator>
148 std::pair<std::reverse_iterator<Iterator>, std::reverse_iterator<Iterator> >
149 make_reverse_range(const std::pair<Iterator, Iterator>& cont)
150 {
151  typedef std::reverse_iterator<Iterator> reverse_it;
152  return make_pair(reverse_it(cont.second), reverse_it(cont.first));
153 }
154 } // namespace ForAll
155 } // namespace util
156 } // namespace mgx
157 
158 #define forall_pointer(obj) (true ? 0 : mgx::util::ForAll::pointer(obj))
159 
165 #define forall_range(typed_var, range) \
166  for(const mgx::util::ForAll::BaseForwardIter& iter \
167  = mgx::util::ForAll::forwardIter(range, forall_pointer((range).first)); \
168  !mgx::util::ForAll::castForwardIter(&iter, forall_pointer((range).first))->is_end(); \
169  ++(mgx::util::ForAll::castForwardIter(&iter, forall_pointer((range).first))->it)) \
170  for(typed_var = mgx::util::ForAll::castForwardIter(&iter, forall_pointer((range).first))->value(); \
171  mgx::util::ForAll::castForwardIter(&iter, forall_pointer((range).first))->brk; \
172  --(mgx::util::ForAll::castForwardIter(&iter, forall_pointer((range).first))->brk))
173 
184 #define forall(typed_var, cont) forall_range(typed_var, mgx::util::ForAll::make_range(cont))
185 
197 #define forall_reverse(typed_var, cont) forall_range(typed_var, mgx::util::ForAll::make_reverse_range(cont))
198 
205 #define forall_named(typed_var, cont, name) \
206  forall_range(typed_var, std::make_pair((cont).begin_ ## name(), (cont).end_ ## name()))
207 #endif // UTIL_FORALL_HPP
This namespace contains all the API of MorphoGraphX.
Definition: Assert.hpp:26