MIP_SDK  v3.0.0-208-gdb90bae
MicroStrain Communications Library for embedded systems
span.hpp
Go to the documentation of this file.
1 #pragma once
2 
3 #ifdef MICROSTRAIN_USE_STD_SPAN
4 
5 #include <span>
6 
7 namespace microstrain
8 {
9 
10  static inline constexpr size_t DYNAMIC_EXTENT = std::dynamic_extent;
11 
12  template<class T, size_t Size=DYNAMIC_EXTENT>
13  using Span = std::span<T, Size>;
14 
15 } // namespace microstrain
16 
17 #else // MICROSTRAIN_USE_STD_SPAN
18 
19 #include <type_traits>
20 #include <stdint.h>
21 #include <stddef.h>
22 
23 namespace microstrain
24 {
25 
26 
27 static constexpr size_t DYNAMIC_EXTENT = SIZE_MAX;
28 
40 template<class T, size_t Extent=DYNAMIC_EXTENT>
41 struct Span
42 {
43  static constexpr size_t extent = Extent;
44 
45  using element_type = T;
46  using value_type = typename std::remove_cv<T>::type;
47  using difference_type = ptrdiff_t;
48  using pointer = T*;
49  using reference = T&;
50  using iterator = T*;
51  using const_pointer = const T*;
52  using const_reference = const T&;
53  using const_iterator = const T*;
54 
55  constexpr Span(pointer ptr) : m_ptr(ptr) {}
56 
57  constexpr pointer begin() const noexcept { return m_ptr; }
58  constexpr pointer end() const noexcept { return m_ptr+extent; }
59 
60  constexpr element_type front() const noexcept { return *m_ptr; }
61  constexpr element_type back() const noexcept { return *m_ptr[extent-1]; }
62 
63  constexpr reference operator[](size_t idx) noexcept { return m_ptr[idx]; }
64  constexpr const_reference operator[](size_t idx) const noexcept { return m_ptr[idx]; }
65 
66  constexpr pointer data() const noexcept { return m_ptr; }
67 
68  [[nodiscard]] constexpr size_t size() const noexcept { return extent; }
69  [[nodiscard]] constexpr bool empty() const noexcept { return extent == 0; }
70 
71  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> subspan(size_t index, size_t length) const { return {m_ptr+index, length}; }
72  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> subspan(size_t index) const { return {m_ptr+index, extent-index}; }
73  template<size_t Offset, size_t Count = DYNAMIC_EXTENT>
74  [[nodiscard]] constexpr Span<T, Count == DYNAMIC_EXTENT ? DYNAMIC_EXTENT : Extent-Count> subspan() const { return {m_ptr+Offset}; }
75 
76  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> first(size_t count) const { return {m_ptr, count};}
77  template<size_t Count>
78  [[nodiscard]] constexpr Span<T, Count> first() const { static_assert(Count<=Extent, "Count out of range"); return {m_ptr}; }
79 
80  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> last(size_t count) const { return {m_ptr+(size()-count), count};}
81  template<size_t Count>
82  [[nodiscard]] constexpr Span<T, Count> last() const { static_assert(Count<=Extent, "Count out of range"); return {m_ptr+(Extent-Count)}; }
83 
84 private:
85  pointer m_ptr = nullptr;
86 };
87 
88 
89 template<class T>
90 struct Span<T, DYNAMIC_EXTENT>
91 {
92  using element_type = T;
93  using value_type = typename std::remove_cv<T>::type;
94  using difference_type = ptrdiff_t;
95  using pointer = T*;
96  using reference = T&;
97  using iterator = T*;
98  using const_pointer = const T*;
99  using const_reference = const T&;
100  using const_iterator = const T*;
101 
102  constexpr Span() = default;
103  constexpr Span(pointer ptr, size_t cnt) : m_ptr(ptr), m_cnt(cnt) {}
104  template<size_t N>
105  constexpr Span(const T (&arr)[N]) : m_ptr(arr), m_cnt(N) {}
106 
107  constexpr pointer begin() const noexcept { return m_ptr; }
108  constexpr pointer end() const noexcept { return m_ptr+m_cnt; }
109 
110  constexpr element_type front() const noexcept { return *m_ptr; }
111  constexpr element_type back() const noexcept { return *m_ptr[m_cnt-1]; }
112 
113  constexpr reference operator[](size_t idx) noexcept { return m_ptr[idx]; }
114  constexpr const_reference operator[](size_t idx) const noexcept { return m_ptr[idx]; }
115 
116  constexpr pointer data() const noexcept { return m_ptr; }
117 
118  [[nodiscard]] constexpr size_t size() const noexcept { return m_cnt; }
119  [[nodiscard]] constexpr bool empty() const noexcept { return m_cnt == 0; }
120 
121  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> subspan(size_t index, size_t length) const { return {m_ptr+index, length}; }
122  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> subspan(size_t index) const { return {m_ptr+index, m_cnt-index}; }
123  template<size_t Offset, size_t Count = DYNAMIC_EXTENT>
124  [[nodiscard]] constexpr Span<T, Count> subspan() const { return {m_ptr+Offset, Count}; }
125 
126  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> first(size_t count) const { return {m_ptr, count};}
127  template<size_t Count>
128  [[nodiscard]] constexpr Span<T, Count> first() const { return {m_ptr}; }
129 
130  [[nodiscard]] constexpr Span<T, DYNAMIC_EXTENT> last(size_t count) const { return {m_ptr+(size()-count), count};}
131  template<size_t Count>
132  [[nodiscard]] constexpr Span<T, Count> last() const { return {m_ptr+(size()-Count)}; }
133 
134 private:
135  pointer m_ptr = nullptr;
136  size_t m_cnt = 0;
137 };
138 
139 
140 } // namespace microstrain
141 
142 #endif // MICROSTRAIN_USE_STD_SPAN
microstrain::Span< T, DYNAMIC_EXTENT >
Definition: span.hpp:90
microstrain::Span::data
constexpr pointer data() const noexcept
Definition: span.hpp:66
microstrain::Span::subspan
constexpr Span< T, DYNAMIC_EXTENT > subspan(size_t index) const
Definition: span.hpp:72
microstrain::Span::Span
constexpr Span(pointer ptr)
Definition: span.hpp:55
microstrain::Span::pointer
T * pointer
Definition: span.hpp:48
microstrain::Span< T, DYNAMIC_EXTENT >::element_type
T element_type
Definition: span.hpp:92
microstrain::Span< T, DYNAMIC_EXTENT >::last
constexpr Span< T, DYNAMIC_EXTENT > last(size_t count) const
Definition: span.hpp:130
microstrain::Span::first
constexpr Span< T, DYNAMIC_EXTENT > first(size_t count) const
Definition: span.hpp:76
microstrain::Span< T, DYNAMIC_EXTENT >::subspan
constexpr Span< T, DYNAMIC_EXTENT > subspan(size_t index, size_t length) const
Definition: span.hpp:121
microstrain::Span::front
constexpr element_type front() const noexcept
Definition: span.hpp:60
microstrain::Span< T, DYNAMIC_EXTENT >::last
constexpr Span< T, Count > last() const
Definition: span.hpp:132
microstrain::Span< T, DYNAMIC_EXTENT >::iterator
T * iterator
Definition: span.hpp:97
microstrain::Span::subspan
constexpr Span< T, DYNAMIC_EXTENT > subspan(size_t index, size_t length) const
Definition: span.hpp:71
microstrain::Span< T, DYNAMIC_EXTENT >::front
constexpr element_type front() const noexcept
Definition: span.hpp:110
microstrain::Span::size
constexpr size_t size() const noexcept
Definition: span.hpp:68
microstrain::Span< T, DYNAMIC_EXTENT >::const_pointer
const T * const_pointer
Definition: span.hpp:98
microstrain::Span::operator[]
constexpr const_reference operator[](size_t idx) const noexcept
Definition: span.hpp:64
microstrain::Span< T, DYNAMIC_EXTENT >::end
constexpr pointer end() const noexcept
Definition: span.hpp:108
microstrain::Span< T, DYNAMIC_EXTENT >::difference_type
ptrdiff_t difference_type
Definition: span.hpp:94
microstrain::Span
Implementation of std::span from C++20.
Definition: span.hpp:41
microstrain::Span< T, DYNAMIC_EXTENT >::empty
constexpr bool empty() const noexcept
Definition: span.hpp:119
microstrain::Span< T, DYNAMIC_EXTENT >::pointer
T * pointer
Definition: span.hpp:95
microstrain::Span< T, DYNAMIC_EXTENT >::value_type
typename std::remove_cv< T >::type value_type
Definition: span.hpp:93
microstrain::Span::first
constexpr Span< T, Count > first() const
Definition: span.hpp:78
mip::metadata::ParameterInfo
Definition: mip_structures.hpp:158
microstrain::Span::subspan
constexpr Span< T, Count==DYNAMIC_EXTENT ? DYNAMIC_EXTENT :Extent-Count > subspan() const
Definition: span.hpp:74
microstrain::Span< T, DYNAMIC_EXTENT >::Span
constexpr Span(const T(&arr)[N])
Definition: span.hpp:105
microstrain::Span< T, DYNAMIC_EXTENT >::const_reference
const T & const_reference
Definition: span.hpp:99
microstrain::Span< T, DYNAMIC_EXTENT >::data
constexpr pointer data() const noexcept
Definition: span.hpp:116
microstrain::Span::begin
constexpr pointer begin() const noexcept
Definition: span.hpp:57
microstrain::Span< T, DYNAMIC_EXTENT >::const_iterator
const T * const_iterator
Definition: span.hpp:100
microstrain::Span::last
constexpr Span< T, Count > last() const
Definition: span.hpp:82
microstrain::Span< T, DYNAMIC_EXTENT >::subspan
constexpr Span< T, DYNAMIC_EXTENT > subspan(size_t index) const
Definition: span.hpp:122
microstrain::Span< const mip::metadata::ParameterInfo >::const_reference
const const mip::metadata::ParameterInfo & const_reference
Definition: span.hpp:52
microstrain::Span< T, DYNAMIC_EXTENT >::begin
constexpr pointer begin() const noexcept
Definition: span.hpp:107
microstrain::Span< const mip::metadata::ParameterInfo >::const_pointer
const const mip::metadata::ParameterInfo * const_pointer
Definition: span.hpp:51
microstrain::Span< T, DYNAMIC_EXTENT >::size
constexpr size_t size() const noexcept
Definition: span.hpp:118
microstrain::Span< const mip::metadata::ParameterInfo >::difference_type
ptrdiff_t difference_type
Definition: span.hpp:47
microstrain::Span::operator[]
constexpr reference operator[](size_t idx) noexcept
Definition: span.hpp:63
microstrain::Span::empty
constexpr bool empty() const noexcept
Definition: span.hpp:69
microstrain::Span::end
constexpr pointer end() const noexcept
Definition: span.hpp:58
microstrain::Span< T, DYNAMIC_EXTENT >::first
constexpr Span< T, Count > first() const
Definition: span.hpp:128
microstrain::Span< T, DYNAMIC_EXTENT >::first
constexpr Span< T, DYNAMIC_EXTENT > first(size_t count) const
Definition: span.hpp:126
microstrain::Span< T, DYNAMIC_EXTENT >::back
constexpr element_type back() const noexcept
Definition: span.hpp:111
microstrain::Span< T, DYNAMIC_EXTENT >::reference
T & reference
Definition: span.hpp:96
microstrain::Span< T, DYNAMIC_EXTENT >::subspan
constexpr Span< T, Count > subspan() const
Definition: span.hpp:124
microstrain::Span::back
constexpr element_type back() const noexcept
Definition: span.hpp:61
microstrain::Span::last
constexpr Span< T, DYNAMIC_EXTENT > last(size_t count) const
Definition: span.hpp:80
microstrain::Span< const mip::metadata::ParameterInfo >::value_type
typename std::remove_cv< const mip::metadata::ParameterInfo >::type value_type
Definition: span.hpp:46
microstrain::Span::extent
static constexpr size_t extent
Definition: span.hpp:43
microstrain::Span< T, DYNAMIC_EXTENT >::Span
constexpr Span(pointer ptr, size_t cnt)
Definition: span.hpp:103
microstrain::Span< T, DYNAMIC_EXTENT >::operator[]
constexpr reference operator[](size_t idx) noexcept
Definition: span.hpp:113
microstrain::Span< T, DYNAMIC_EXTENT >::operator[]
constexpr const_reference operator[](size_t idx) const noexcept
Definition: span.hpp:114
microstrain
Definition: embedded_time.h:8
microstrain::Span< const mip::metadata::ParameterInfo >::const_iterator
const const mip::metadata::ParameterInfo * const_iterator
Definition: span.hpp:53
mip::metadata::Span
microstrain::Span< T > Span
Definition: mip_structures.hpp:12