reverse.h
Go to the documentation of this file.
1 #ifndef GAUDIKERNEL_REVERSE_H
2 #define GAUDIKERNEL_REVERSE_H
3 //
4 // provide a generic 'reverse' function for use in range-based for loops.
5 //
6 // example:
7 //
8 // #include "GaudiKernel/reverse.h"
9 // auto l = { 1,2,3,4 };
10 // for ( const auto& i : reverse( l ) ) std::cout << i << std::endl;
11 //
12 // Note that it is perfectly fine to reverse a temporary. The temporary
13 // will be moved into the reverse_wrapper, and thus kept alive for the
14 // duration of the loop. In case reverse is called on an lvalue, the wrapper
15 // will take a reference, so no copy will be performed. (if you wonder how
16 // the code below (very implicitly) distinguishes between the two cases,
17 // google for 'C++11 reference collapsing' -- short version: C++ does not
18 // allow references to references, so in cases where this would happen,
19 // one gets an lvalue reference)
20 //
21 // Also note that reverse_wrapper does not have a constructor, but this
22 // implies that it does meet the requirements for aggregate initializaton,
23 // which allows for {} initialization of its member.
24 //
25 
26 #include <utility>
27 
28 template <typename Iterable>
29 struct reverse_wrapper { Iterable iterable; };
30 
31 template <typename T>
32 reverse_wrapper<T> reverse(T&& iterable) { return { std::forward<T>(iterable) }; }
33 
34 
35 #if defined __GNUC__ && __GNUC__ < 5
36 
37 // std::rbegin and std::rend require gcc 5.0 or later (or clang 3.5 or later)
38 template <typename T>
39 auto begin(reverse_wrapper<T>& w) -> decltype(w.iterable.rbegin()) { return w.iterable.rbegin(); }
40 template <typename T>
41 auto end(reverse_wrapper<T>& w) -> decltype(w.iterable.rend()) { return w.iterable.rend(); }
42 
43 #else
44 
45 #include <iterator>
46 template <typename T>
47 auto begin(reverse_wrapper<T>& w) { using std::rbegin; return rbegin(w.iterable); }
48 template <typename T>
49 auto end(reverse_wrapper<T>& w) { using std::rend; return rend(w.iterable); }
50 
51 #endif
52 
53 
54 #endif
Iterable iterable
Definition: reverse.h:29
auto begin(reverse_wrapper< T > &w)
Definition: reverse.h:47
auto end(reverse_wrapper< T > &w)
Definition: reverse.h:49
reverse_wrapper< T > reverse(T &&iterable)
Definition: reverse.h:32