subrange.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289
  1. // -*- C++ -*-
  2. //===----------------------------------------------------------------------===//
  3. //
  4. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  5. // See https://llvm.org/LICENSE.txt for license information.
  6. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  7. //
  8. //===----------------------------------------------------------------------===//
  9. #ifndef _LIBCPP___RANGES_SUBRANGE_H
  10. #define _LIBCPP___RANGES_SUBRANGE_H
  11. #include <__assert>
  12. #include <__concepts/constructible.h>
  13. #include <__concepts/convertible_to.h>
  14. #include <__concepts/copyable.h>
  15. #include <__concepts/derived_from.h>
  16. #include <__concepts/different_from.h>
  17. #include <__config>
  18. #include <__iterator/advance.h>
  19. #include <__iterator/concepts.h>
  20. #include <__iterator/incrementable_traits.h>
  21. #include <__iterator/iterator_traits.h>
  22. #include <__ranges/access.h>
  23. #include <__ranges/concepts.h>
  24. #include <__ranges/dangling.h>
  25. #include <__ranges/enable_borrowed_range.h>
  26. #include <__ranges/size.h>
  27. #include <__ranges/view_interface.h>
  28. #include <__tuple>
  29. #include <__utility/move.h>
  30. #include <type_traits>
  31. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  32. # pragma GCC system_header
  33. #endif
  34. _LIBCPP_BEGIN_NAMESPACE_STD
  35. #if !defined(_LIBCPP_HAS_NO_CONCEPTS) && !defined(_LIBCPP_HAS_NO_INCOMPLETE_RANGES)
  36. namespace ranges {
  37. template<class _From, class _To>
  38. concept __uses_nonqualification_pointer_conversion =
  39. is_pointer_v<_From> && is_pointer_v<_To> &&
  40. !convertible_to<remove_pointer_t<_From>(*)[], remove_pointer_t<_To>(*)[]>;
  41. template<class _From, class _To>
  42. concept __convertible_to_non_slicing =
  43. convertible_to<_From, _To> &&
  44. !__uses_nonqualification_pointer_conversion<decay_t<_From>, decay_t<_To>>;
  45. template<class _Tp>
  46. concept __pair_like =
  47. !is_reference_v<_Tp> && requires(_Tp __t) {
  48. typename tuple_size<_Tp>::type; // Ensures `tuple_size<T>` is complete.
  49. requires derived_from<tuple_size<_Tp>, integral_constant<size_t, 2>>;
  50. typename tuple_element_t<0, remove_const_t<_Tp>>;
  51. typename tuple_element_t<1, remove_const_t<_Tp>>;
  52. { std::get<0>(__t) } -> convertible_to<const tuple_element_t<0, _Tp>&>;
  53. { std::get<1>(__t) } -> convertible_to<const tuple_element_t<1, _Tp>&>;
  54. };
  55. template<class _Pair, class _Iter, class _Sent>
  56. concept __pair_like_convertible_from =
  57. !range<_Pair> && __pair_like<_Pair> &&
  58. constructible_from<_Pair, _Iter, _Sent> &&
  59. __convertible_to_non_slicing<_Iter, tuple_element_t<0, _Pair>> &&
  60. convertible_to<_Sent, tuple_element_t<1, _Pair>>;
  61. enum class _LIBCPP_ENUM_VIS subrange_kind : bool { unsized, sized };
  62. template<input_or_output_iterator _Iter, sentinel_for<_Iter> _Sent = _Iter,
  63. subrange_kind _Kind = sized_sentinel_for<_Sent, _Iter>
  64. ? subrange_kind::sized
  65. : subrange_kind::unsized>
  66. requires (_Kind == subrange_kind::sized || !sized_sentinel_for<_Sent, _Iter>)
  67. class _LIBCPP_TEMPLATE_VIS subrange
  68. : public view_interface<subrange<_Iter, _Sent, _Kind>>
  69. {
  70. private:
  71. static constexpr bool _StoreSize = (_Kind == subrange_kind::sized && !sized_sentinel_for<_Sent, _Iter>);
  72. static constexpr bool _MustProvideSizeAtConstruction = !_StoreSize; // just to improve compiler diagnostics
  73. struct _Empty { constexpr _Empty(auto) noexcept { } };
  74. using _Size = conditional_t<_StoreSize, make_unsigned_t<iter_difference_t<_Iter>>, _Empty>;
  75. _LIBCPP_NO_UNIQUE_ADDRESS _Iter __begin_ = _Iter();
  76. _LIBCPP_NO_UNIQUE_ADDRESS _Sent __end_ = _Sent();
  77. _LIBCPP_NO_UNIQUE_ADDRESS _Size __size_ = 0;
  78. public:
  79. _LIBCPP_HIDE_FROM_ABI
  80. subrange() requires default_initializable<_Iter> = default;
  81. _LIBCPP_HIDE_FROM_ABI
  82. constexpr subrange(__convertible_to_non_slicing<_Iter> auto __iter, _Sent __sent)
  83. requires _MustProvideSizeAtConstruction
  84. : __begin_(std::move(__iter)), __end_(std::move(__sent))
  85. { }
  86. _LIBCPP_HIDE_FROM_ABI
  87. constexpr subrange(__convertible_to_non_slicing<_Iter> auto __iter, _Sent __sent,
  88. make_unsigned_t<iter_difference_t<_Iter>> __n)
  89. requires (_Kind == subrange_kind::sized)
  90. : __begin_(std::move(__iter)), __end_(std::move(__sent)), __size_(__n)
  91. {
  92. if constexpr (sized_sentinel_for<_Sent, _Iter>)
  93. _LIBCPP_ASSERT((__end_ - __begin_) == static_cast<iter_difference_t<_Iter>>(__n),
  94. "std::ranges::subrange was passed an invalid size hint");
  95. }
  96. template<__different_from<subrange> _Range>
  97. requires borrowed_range<_Range> &&
  98. __convertible_to_non_slicing<iterator_t<_Range>, _Iter> &&
  99. convertible_to<sentinel_t<_Range>, _Sent>
  100. _LIBCPP_HIDE_FROM_ABI
  101. constexpr subrange(_Range&& __range)
  102. requires (!_StoreSize)
  103. : subrange(ranges::begin(__range), ranges::end(__range))
  104. { }
  105. template<__different_from<subrange> _Range>
  106. requires borrowed_range<_Range> &&
  107. __convertible_to_non_slicing<iterator_t<_Range>, _Iter> &&
  108. convertible_to<sentinel_t<_Range>, _Sent>
  109. _LIBCPP_HIDE_FROM_ABI
  110. constexpr subrange(_Range&& __range)
  111. requires _StoreSize && sized_range<_Range>
  112. : subrange(__range, ranges::size(__range))
  113. { }
  114. template<borrowed_range _Range>
  115. requires __convertible_to_non_slicing<iterator_t<_Range>, _Iter> &&
  116. convertible_to<sentinel_t<_Range>, _Sent>
  117. _LIBCPP_HIDE_FROM_ABI
  118. constexpr subrange(_Range&& __range, make_unsigned_t<iter_difference_t<_Iter>> __n)
  119. requires (_Kind == subrange_kind::sized)
  120. : subrange(ranges::begin(__range), ranges::end(__range), __n)
  121. { }
  122. template<__different_from<subrange> _Pair>
  123. requires __pair_like_convertible_from<_Pair, const _Iter&, const _Sent&>
  124. _LIBCPP_HIDE_FROM_ABI
  125. constexpr operator _Pair() const {
  126. return _Pair(__begin_, __end_);
  127. }
  128. _LIBCPP_HIDE_FROM_ABI
  129. constexpr _Iter begin() const requires copyable<_Iter> {
  130. return __begin_;
  131. }
  132. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr _Iter begin() requires (!copyable<_Iter>) {
  133. return std::move(__begin_);
  134. }
  135. _LIBCPP_HIDE_FROM_ABI
  136. constexpr _Sent end() const {
  137. return __end_;
  138. }
  139. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr bool empty() const {
  140. return __begin_ == __end_;
  141. }
  142. _LIBCPP_HIDE_FROM_ABI
  143. constexpr make_unsigned_t<iter_difference_t<_Iter>> size() const
  144. requires (_Kind == subrange_kind::sized)
  145. {
  146. if constexpr (_StoreSize)
  147. return __size_;
  148. else
  149. return std::__to_unsigned_like(__end_ - __begin_);
  150. }
  151. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr subrange next(iter_difference_t<_Iter> __n = 1) const&
  152. requires forward_iterator<_Iter>
  153. {
  154. auto __tmp = *this;
  155. __tmp.advance(__n);
  156. return __tmp;
  157. }
  158. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr subrange next(iter_difference_t<_Iter> __n = 1) && {
  159. advance(__n);
  160. return std::move(*this);
  161. }
  162. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr subrange prev(iter_difference_t<_Iter> __n = 1) const
  163. requires bidirectional_iterator<_Iter>
  164. {
  165. auto __tmp = *this;
  166. __tmp.advance(-__n);
  167. return __tmp;
  168. }
  169. _LIBCPP_HIDE_FROM_ABI
  170. constexpr subrange& advance(iter_difference_t<_Iter> __n) {
  171. if constexpr (bidirectional_iterator<_Iter>) {
  172. if (__n < 0) {
  173. ranges::advance(__begin_, __n);
  174. if constexpr (_StoreSize)
  175. __size_ += std::__to_unsigned_like(-__n);
  176. return *this;
  177. }
  178. }
  179. auto __d = __n - ranges::advance(__begin_, __n, __end_);
  180. if constexpr (_StoreSize)
  181. __size_ -= std::__to_unsigned_like(__d);
  182. return *this;
  183. }
  184. };
  185. template<input_or_output_iterator _Iter, sentinel_for<_Iter> _Sent>
  186. subrange(_Iter, _Sent) -> subrange<_Iter, _Sent>;
  187. template<input_or_output_iterator _Iter, sentinel_for<_Iter> _Sent>
  188. subrange(_Iter, _Sent, make_unsigned_t<iter_difference_t<_Iter>>)
  189. -> subrange<_Iter, _Sent, subrange_kind::sized>;
  190. template<borrowed_range _Range>
  191. subrange(_Range&&) -> subrange<iterator_t<_Range>, sentinel_t<_Range>,
  192. (sized_range<_Range> || sized_sentinel_for<sentinel_t<_Range>, iterator_t<_Range>>)
  193. ? subrange_kind::sized : subrange_kind::unsized>;
  194. template<borrowed_range _Range>
  195. subrange(_Range&&, make_unsigned_t<range_difference_t<_Range>>)
  196. -> subrange<iterator_t<_Range>, sentinel_t<_Range>, subrange_kind::sized>;
  197. template<size_t _Index, class _Iter, class _Sent, subrange_kind _Kind>
  198. requires ((_Index == 0 && copyable<_Iter>) || _Index == 1)
  199. _LIBCPP_HIDE_FROM_ABI
  200. constexpr auto get(const subrange<_Iter, _Sent, _Kind>& __subrange) {
  201. if constexpr (_Index == 0)
  202. return __subrange.begin();
  203. else
  204. return __subrange.end();
  205. }
  206. template<size_t _Index, class _Iter, class _Sent, subrange_kind _Kind>
  207. requires (_Index < 2)
  208. _LIBCPP_HIDE_FROM_ABI
  209. constexpr auto get(subrange<_Iter, _Sent, _Kind>&& __subrange) {
  210. if constexpr (_Index == 0)
  211. return __subrange.begin();
  212. else
  213. return __subrange.end();
  214. }
  215. template<class _Ip, class _Sp, subrange_kind _Kp>
  216. inline constexpr bool enable_borrowed_range<subrange<_Ip, _Sp, _Kp>> = true;
  217. template<range _Rp>
  218. using borrowed_subrange_t = _If<borrowed_range<_Rp>, subrange<iterator_t<_Rp>>, dangling>;
  219. } // namespace ranges
  220. // [range.subrange.general]
  221. using ranges::get;
  222. // [ranges.syn]
  223. template<class _Ip, class _Sp, ranges::subrange_kind _Kp>
  224. struct tuple_size<ranges::subrange<_Ip, _Sp, _Kp>> : integral_constant<size_t, 2> {};
  225. template<class _Ip, class _Sp, ranges::subrange_kind _Kp>
  226. struct tuple_element<0, ranges::subrange<_Ip, _Sp, _Kp>> {
  227. using type = _Ip;
  228. };
  229. template<class _Ip, class _Sp, ranges::subrange_kind _Kp>
  230. struct tuple_element<1, ranges::subrange<_Ip, _Sp, _Kp>> {
  231. using type = _Sp;
  232. };
  233. template<class _Ip, class _Sp, ranges::subrange_kind _Kp>
  234. struct tuple_element<0, const ranges::subrange<_Ip, _Sp, _Kp>> {
  235. using type = _Ip;
  236. };
  237. template<class _Ip, class _Sp, ranges::subrange_kind _Kp>
  238. struct tuple_element<1, const ranges::subrange<_Ip, _Sp, _Kp>> {
  239. using type = _Sp;
  240. };
  241. #endif // !defined(_LIBCPP_HAS_NO_CONCEPTS) && !defined(_LIBCPP_HAS_NO_INCOMPLETE_RANGES)
  242. _LIBCPP_END_NAMESPACE_STD
  243. #endif // _LIBCPP___RANGES_SUBRANGE_H