Compute Library
 21.08
Iterable.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_MISC_ITERABLE_H
25 #define ARM_COMPUTE_MISC_ITERABLE_H
26 
27 #include <iterator>
28 
29 namespace arm_compute
30 {
31 namespace utils
32 {
33 namespace iterable
34 {
35 /** Reverse range iterable class
36  *
37  * @tparam T Type to create a reverse range on
38  */
39 template <typename T>
41 {
42 public:
43  /** Default constructor
44  *
45  * @param[in] it Value to reverse iterate on
46  */
47  explicit reverse_iterable(T &it)
48  : _it(it)
49  {
50  }
51 
52  /** Get beginning of iterator.
53  *
54  * @return beginning of iterator.
55  */
56  typename T::reverse_iterator begin()
57  {
58  return _it.rbegin();
59  }
60 
61  /** Get end of iterator.
62  *
63  * @return end of iterator.
64  */
65  typename T::reverse_iterator end()
66  {
67  return _it.rend();
68  }
69 
70  /** Get beginning of const iterator.
71  *
72  * @return beginning of const iterator.
73  */
74  typename T::const_reverse_iterator cbegin()
75  {
76  return _it.rbegin();
77  }
78 
79  /** Get end of const iterator.
80  *
81  * @return end of const iterator.
82  */
83  typename T::const_reverse_iterator cend()
84  {
85  return _it.rend();
86  }
87 
88 private:
89  T &_it;
90 };
91 
92 /** Creates a reverse iterable for a given type
93  *
94  * @tparam T Type to create a reverse iterable on
95  *
96  * @param[in] val Iterable input
97  *
98  * @return Reverse iterable container
99  */
100 template <typename T>
102 {
103  return reverse_iterable<T>(val);
104 }
105 } // namespace iterable
106 } // namespace utils
107 } // namespace arm_compute
108 #endif /* ARM_COMPUTE_MISC_ITERABLE_H */
T::const_reverse_iterator cend()
Get end of const iterator.
Definition: Iterable.h:83
Copyright (c) 2017-2021 Arm Limited.
reverse_iterable(T &it)
Default constructor.
Definition: Iterable.h:47
T::reverse_iterator begin()
Get beginning of iterator.
Definition: Iterable.h:56
T::const_reverse_iterator cbegin()
Get beginning of const iterator.
Definition: Iterable.h:74
T::reverse_iterator end()
Get end of iterator.
Definition: Iterable.h:65
Reverse range iterable class.
Definition: Iterable.h:40
reverse_iterable< T > reverse_iterate(T &val)
Creates a reverse iterable for a given type.
Definition: Iterable.h:101