iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
IteratorRange.H
Go to the documentation of this file.
1 /*! @file
2  @author Shane Grant
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 #ifndef INCLUDE_NRT_CORE_DESIGN_ITERATORRANGE_H_
36 #define INCLUDE_NRT_CORE_DESIGN_ITERATORRANGE_H_
37 
38 namespace nrt
39 {
40  //! A rudimentary implementation of an iterator range
41  /*! Iterator ranges are a currently under discussion addition to C++, which
42  can be followed here in detail: http://www.open-std.org/mailman/listinfo/ranges.
43 
44  Two example implementations can be found at https://github.com/marcinz/libcxx-ranges and
45  http://llvm.org/viewvc/llvm-project/lld/trunk/include/lld/Core/range.h?view=markup.
46 
47  This range class presented here is a lightweight wrapper for two iterators that offers easy
48  use with range based for loops introduced in C++11.
49 
50  @tparam IteratorType The type of the iterator to wrap up */
51  template <class IteratorType>
53  {
54  public:
55  typedef typename std::iterator_traits<IteratorType>::iterator_category iterator_category;
56  typedef typename std::iterator_traits<IteratorType>::value_type value_type;
57  typedef typename std::iterator_traits<IteratorType>::difference_type difference_type;
58  typedef typename std::iterator_traits<IteratorType>::reference reference;
59  typedef typename std::iterator_traits<IteratorType>::pointer pointer;
60 
61  //! Create an empty, likely invalid range
62  IteratorRange();
63 
64  //! Create a range from two iterators
65  IteratorRange( IteratorType && begin, IteratorType && end );
66 
67  //! Copy construction
68  IteratorRange( IteratorRange const & other ) = default;
69 
70  //! Move construction
71  IteratorRange( IteratorRange && other ) = default;
72 
73  //! Copy assignment
74  IteratorRange & operator=( IteratorRange const & other ) = default;
75 
76  //! Move assignment
77  IteratorRange & operator=( IteratorRange && other ) = default;
78 
79  //! Get the begin iterator
80  IteratorType begin() const;
81 
82  //! Get the end iterator
83  IteratorType end() const;
84 
85  private:
86  IteratorType itsBegin;
87  IteratorType itsEnd;
88  }; // class IteratorRange
89 }; // namespace nrt
90 
92 
93 #endif //INCLUDE_NRT_CORE_DESIGN_ITERATORRANGE_H_