Range.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Louis Langholtz https://github.com/louis-langholtz/PlayRho
3  *
4  * This software is provided 'as-is', without any express or implied
5  * warranty. In no event will the authors be held liable for any damages
6  * arising from the use of this software.
7  *
8  * Permission is granted to anyone to use this software for any purpose,
9  * including commercial applications, and to alter it and redistribute it
10  * freely, subject to the following restrictions:
11  *
12  * 1. The origin of this software must not be misrepresented; you must not
13  * claim that you wrote the original software. If you use this software
14  * in a product, an acknowledgment in the product documentation would be
15  * appreciated but is not required.
16  * 2. Altered source versions must be plainly marked as such, and must not be
17  * misrepresented as being the original software.
18  * 3. This notice may not be removed or altered from any source distribution.
19  */
20 
21 #ifndef PLAYRHO_COMMON_RANGE_HPP
22 #define PLAYRHO_COMMON_RANGE_HPP
23 
24 #include <PlayRho/Defines.hpp>
25 #include <cstddef>
26 
27 namespace playrho {
28 
30  template <typename IT>
31  class Range
32  {
33  public:
34 
36  using iterator_type = IT;
37 
39  PLAYRHO_CONSTEXPR inline Range(iterator_type iter_begin, iterator_type iter_end) noexcept:
40  m_begin{iter_begin}, m_end{iter_end}
41  {
42  // Intentionally empty.
43  }
44 
46  PLAYRHO_CONSTEXPR iterator_type begin() const noexcept
47  {
48  return m_begin;
49  }
50 
52  PLAYRHO_CONSTEXPR iterator_type end() const noexcept
53  {
54  return m_end;
55  }
56 
58  PLAYRHO_CONSTEXPR bool empty() const noexcept
59  {
60  return m_begin == m_end;
61  }
62 
63  private:
64  iterator_type m_begin;
65  iterator_type m_end;
66  };
67 
69  template <typename IT>
70  class SizedRange: public Range<IT>
71  {
72  public:
74  using size_type = std::size_t;
75 
77  PLAYRHO_CONSTEXPR inline SizedRange(typename Range<IT>::iterator_type iter_begin,
78  typename Range<IT>::iterator_type iter_end,
79  size_type size) noexcept:
80  Range<IT>{iter_begin, iter_end}, m_size{size}
81  {
82  // Intentionally empty.
83  }
84 
86  PLAYRHO_CONSTEXPR size_type size() const noexcept
87  {
88  return m_size;
89  }
90 
91  private:
92  size_type m_size;
93  };
94 
95 } // namespace playrho
96 
97 #endif // PLAYRHO_COMMON_RANGE_HPP