span_ext 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. ///////////////////////////////////////////////////////////////////////////////
  2. //
  3. // Copyright (c) 2015 Microsoft Corporation. All rights reserved.
  4. //
  5. // This code is licensed under the MIT License (MIT).
  6. //
  7. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  8. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  9. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  10. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  11. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  12. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  13. // THE SOFTWARE.
  14. //
  15. ///////////////////////////////////////////////////////////////////////////////
  16. #ifndef GSL_SPAN_EXT_H
  17. #define GSL_SPAN_EXT_H
  18. ///////////////////////////////////////////////////////////////////////////////
  19. //
  20. // File: span_ext
  21. // Purpose: continue offering features that have been cut from the official
  22. // implementation of span.
  23. // While modernizing gsl::span a number of features needed to be removed to
  24. // be compliant with the design of std::span
  25. //
  26. ///////////////////////////////////////////////////////////////////////////////
  27. #include "assert" // GSL_KERNEL_MODE
  28. #include "util" // for narrow_cast, narrow
  29. #include <cstddef> // for ptrdiff_t, size_t
  30. #include <utility>
  31. #ifndef GSL_KERNEL_MODE
  32. #include <algorithm> // for lexicographical_compare
  33. #endif // GSL_KERNEL_MODE
  34. namespace gsl
  35. {
  36. // [span.views.constants], constants
  37. GSL_INLINE constexpr const std::size_t dynamic_extent = narrow_cast<std::size_t>(-1);
  38. template <class ElementType, std::size_t Extent = dynamic_extent>
  39. class span;
  40. // std::equal and std::lexicographical_compare are not /kernel compatible
  41. // so all comparison operators must be removed for kernel mode.
  42. #ifndef GSL_KERNEL_MODE
  43. // [span.comparison], span comparison operators
  44. template <class ElementType, std::size_t FirstExtent, std::size_t SecondExtent>
  45. constexpr bool operator==(span<ElementType, FirstExtent> l, span<ElementType, SecondExtent> r)
  46. {
  47. return std::equal(l.begin(), l.end(), r.begin(), r.end());
  48. }
  49. template <class ElementType, std::size_t Extent>
  50. constexpr bool operator!=(span<ElementType, Extent> l, span<ElementType, Extent> r)
  51. {
  52. return !(l == r);
  53. }
  54. template <class ElementType, std::size_t Extent>
  55. constexpr bool operator<(span<ElementType, Extent> l, span<ElementType, Extent> r)
  56. {
  57. return std::lexicographical_compare(l.begin(), l.end(), r.begin(), r.end());
  58. }
  59. template <class ElementType, std::size_t Extent>
  60. constexpr bool operator<=(span<ElementType, Extent> l, span<ElementType, Extent> r)
  61. {
  62. return !(l > r);
  63. }
  64. template <class ElementType, std::size_t Extent>
  65. constexpr bool operator>(span<ElementType, Extent> l, span<ElementType, Extent> r)
  66. {
  67. return r < l;
  68. }
  69. template <class ElementType, std::size_t Extent>
  70. constexpr bool operator>=(span<ElementType, Extent> l, span<ElementType, Extent> r)
  71. {
  72. return !(l < r);
  73. }
  74. #endif // GSL_KERNEL_MODE
  75. //
  76. // make_span() - Utility functions for creating spans
  77. //
  78. template <class ElementType>
  79. constexpr span<ElementType> make_span(ElementType* ptr, typename span<ElementType>::size_type count)
  80. {
  81. return span<ElementType>(ptr, count);
  82. }
  83. template <class ElementType>
  84. constexpr span<ElementType> make_span(ElementType* firstElem, ElementType* lastElem)
  85. {
  86. return span<ElementType>(firstElem, lastElem);
  87. }
  88. template <class ElementType, std::size_t N>
  89. constexpr span<ElementType, N> make_span(ElementType (&arr)[N]) noexcept
  90. {
  91. return span<ElementType, N>(arr);
  92. }
  93. template <class Container>
  94. constexpr span<typename Container::value_type> make_span(Container& cont)
  95. {
  96. return span<typename Container::value_type>(cont);
  97. }
  98. template <class Container>
  99. constexpr span<const typename Container::value_type> make_span(const Container& cont)
  100. {
  101. return span<const typename Container::value_type>(cont);
  102. }
  103. template <class Ptr>
  104. [[deprecated("This function is deprecated. See GSL issue #1092.")]]
  105. constexpr span<typename Ptr::element_type> make_span(Ptr& cont, std::size_t count)
  106. {
  107. return span<typename Ptr::element_type>(cont, count);
  108. }
  109. template <class Ptr>
  110. [[deprecated("This function is deprecated. See GSL issue #1092.")]]
  111. constexpr span<typename Ptr::element_type> make_span(Ptr& cont)
  112. {
  113. return span<typename Ptr::element_type>(cont);
  114. }
  115. // Specialization of gsl::at for span
  116. template <class ElementType, std::size_t Extent>
  117. constexpr ElementType& at(span<ElementType, Extent> s, index i)
  118. {
  119. // No bounds checking here because it is done in span::operator[] called below
  120. Ensures(i >= 0);
  121. return s[narrow_cast<std::size_t>(i)];
  122. }
  123. // [span.obs] Free observer functions
  124. template <class ElementType, std::size_t Extent>
  125. constexpr std::ptrdiff_t ssize(const span<ElementType, Extent>& s) noexcept
  126. {
  127. return static_cast<std::ptrdiff_t>(s.size());
  128. }
  129. // [span.iter] Free functions for begin/end functions
  130. template <class ElementType, std::size_t Extent>
  131. constexpr typename span<ElementType, Extent>::iterator
  132. begin(const span<ElementType, Extent>& s) noexcept
  133. {
  134. return s.begin();
  135. }
  136. template <class ElementType, std::size_t Extent = dynamic_extent>
  137. constexpr typename span<ElementType, Extent>::iterator
  138. end(const span<ElementType, Extent>& s) noexcept
  139. {
  140. return s.end();
  141. }
  142. template <class ElementType, std::size_t Extent>
  143. constexpr typename span<ElementType, Extent>::reverse_iterator
  144. rbegin(const span<ElementType, Extent>& s) noexcept
  145. {
  146. return s.rbegin();
  147. }
  148. template <class ElementType, std::size_t Extent>
  149. constexpr typename span<ElementType, Extent>::reverse_iterator
  150. rend(const span<ElementType, Extent>& s) noexcept
  151. {
  152. return s.rend();
  153. }
  154. template <class ElementType, std::size_t Extent>
  155. constexpr typename span<ElementType, Extent>::iterator
  156. cbegin(const span<ElementType, Extent>& s) noexcept
  157. {
  158. return s.begin();
  159. }
  160. template <class ElementType, std::size_t Extent = dynamic_extent>
  161. constexpr typename span<ElementType, Extent>::iterator
  162. cend(const span<ElementType, Extent>& s) noexcept
  163. {
  164. return s.end();
  165. }
  166. template <class ElementType, std::size_t Extent>
  167. constexpr typename span<ElementType, Extent>::reverse_iterator
  168. crbegin(const span<ElementType, Extent>& s) noexcept
  169. {
  170. return s.rbegin();
  171. }
  172. template <class ElementType, std::size_t Extent>
  173. constexpr typename span<ElementType, Extent>::reverse_iterator
  174. crend(const span<ElementType, Extent>& s) noexcept
  175. {
  176. return s.rend();
  177. }
  178. } // namespace gsl
  179. #endif // GSL_SPAN_EXT_H