MIRA
IteratorRangeContainer.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_ITERATORRANGECONTAINER_H_
48 #define _MIRA_ITERATORRANGECONTAINER_H_
49 
50 #include <list> // to include stl iterator_base
51 
52 namespace mira {
53 
55 
63 template <typename Iterator>
65 {
66 public:
67 
70  mEnd(mBegin) {}
71 
73  IteratorRangeContainer(const Iterator& begin, const Iterator& end) :
74  mBegin(begin), mEnd(end) {}
75 
76 public:
77 
78  typedef Iterator iterator;
79  typedef typename Iterator::reference reference;
80 
81 public:
82 
84  iterator begin() const {
85  return mBegin;
86  }
87 
89  iterator end() const {
90  return mEnd;
91  }
92 
94  reference front() const { return *begin(); }
95 
97  reference back() const {
98  iterator b = end();
99  --b;
100  return *b;
101  }
102 
104  std::size_t size() const {
105  return std::distance(begin(), end());
106  }
107 
108 private:
109 
110  Iterator mBegin;
111  Iterator mEnd;
112 };
113 
115 
116 } // namespace
117 
118 #endif /* _MIRA_ITERATORRANGECONTAINER_H_ */
std::size_t size() const
Returns the number of elements in the given range.
Definition: IteratorRangeContainer.h:104
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
IteratorRangeContainer(const Iterator &begin, const Iterator &end)
Constructor taking two iterators that define the range.
Definition: IteratorRangeContainer.h:73
IteratorRangeContainer()
Default constructor.
Definition: IteratorRangeContainer.h:69
Iterator::reference reference
Definition: IteratorRangeContainer.h:79
reference front() const
Returns the first element in the range.
Definition: IteratorRangeContainer.h:94
Iterator iterator
Definition: IteratorRangeContainer.h:78
iterator begin() const
Returns an iterator to the first element of the range.
Definition: IteratorRangeContainer.h:84
reference back() const
Returns the last element in the range.
Definition: IteratorRangeContainer.h:97
iterator end() const
Returns an iterator to the end of the range.
Definition: IteratorRangeContainer.h:89
Wraps an STL conform container around a range of values within another container. ...
Definition: IteratorRangeContainer.h:64