transform_view.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  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_TRANSFORM_VIEW_H
  10. #define _LIBCPP___RANGES_TRANSFORM_VIEW_H
  11. #include <__compare/three_way_comparable.h>
  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/equality_comparable.h>
  17. #include <__concepts/invocable.h>
  18. #include <__config>
  19. #include <__functional/bind_back.h>
  20. #include <__functional/invoke.h>
  21. #include <__functional/perfect_forward.h>
  22. #include <__iterator/concepts.h>
  23. #include <__iterator/iterator_traits.h>
  24. #include <__memory/addressof.h>
  25. #include <__ranges/access.h>
  26. #include <__ranges/all.h>
  27. #include <__ranges/concepts.h>
  28. #include <__ranges/empty.h>
  29. #include <__ranges/movable_box.h>
  30. #include <__ranges/range_adaptor.h>
  31. #include <__ranges/size.h>
  32. #include <__ranges/view_interface.h>
  33. #include <__type_traits/conditional.h>
  34. #include <__type_traits/decay.h>
  35. #include <__type_traits/is_nothrow_constructible.h>
  36. #include <__type_traits/is_object.h>
  37. #include <__type_traits/is_reference.h>
  38. #include <__type_traits/maybe_const.h>
  39. #include <__type_traits/remove_cvref.h>
  40. #include <__utility/forward.h>
  41. #include <__utility/in_place.h>
  42. #include <__utility/move.h>
  43. #if !defined(_LIBCPP_HAS_NO_PRAGMA_SYSTEM_HEADER)
  44. # pragma GCC system_header
  45. #endif
  46. _LIBCPP_PUSH_MACROS
  47. #include <__undef_macros>
  48. _LIBCPP_BEGIN_NAMESPACE_STD
  49. #if _LIBCPP_STD_VER >= 20
  50. namespace ranges {
  51. template <class _Fn, class _View>
  52. concept __regular_invocable_with_range_ref = regular_invocable<_Fn, range_reference_t<_View>>;
  53. template <class _View, class _Fn>
  54. concept __transform_view_constraints =
  55. view<_View> && is_object_v<_Fn> && regular_invocable<_Fn&, range_reference_t<_View>> &&
  56. __can_reference<invoke_result_t<_Fn&, range_reference_t<_View>>>;
  57. # if _LIBCPP_STD_VER >= 23
  58. template <input_range _View, move_constructible _Fn>
  59. # else
  60. template <input_range _View, copy_constructible _Fn>
  61. # endif
  62. requires __transform_view_constraints<_View, _Fn>
  63. class _LIBCPP_ABI_LLVM18_NO_UNIQUE_ADDRESS transform_view : public view_interface<transform_view<_View, _Fn>> {
  64. template <bool>
  65. class __iterator;
  66. template <bool>
  67. class __sentinel;
  68. _LIBCPP_NO_UNIQUE_ADDRESS __movable_box<_Fn> __func_;
  69. _LIBCPP_NO_UNIQUE_ADDRESS _View __base_ = _View();
  70. public:
  71. _LIBCPP_HIDE_FROM_ABI transform_view()
  72. requires default_initializable<_View> && default_initializable<_Fn>
  73. = default;
  74. _LIBCPP_HIDE_FROM_ABI constexpr _LIBCPP_EXPLICIT_SINCE_CXX23 transform_view(_View __base, _Fn __func)
  75. : __func_(std::in_place, std::move(__func)), __base_(std::move(__base)) {}
  76. _LIBCPP_HIDE_FROM_ABI constexpr _View base() const&
  77. requires copy_constructible<_View>
  78. {
  79. return __base_;
  80. }
  81. _LIBCPP_HIDE_FROM_ABI constexpr _View base() && { return std::move(__base_); }
  82. _LIBCPP_HIDE_FROM_ABI constexpr __iterator<false> begin() { return __iterator<false>{*this, ranges::begin(__base_)}; }
  83. _LIBCPP_HIDE_FROM_ABI constexpr __iterator<true> begin() const
  84. requires range<const _View> && __regular_invocable_with_range_ref<const _Fn&, const _View>
  85. {
  86. return __iterator<true>(*this, ranges::begin(__base_));
  87. }
  88. _LIBCPP_HIDE_FROM_ABI constexpr __sentinel<false> end() { return __sentinel<false>(ranges::end(__base_)); }
  89. _LIBCPP_HIDE_FROM_ABI constexpr __iterator<false> end()
  90. requires common_range<_View>
  91. {
  92. return __iterator<false>(*this, ranges::end(__base_));
  93. }
  94. _LIBCPP_HIDE_FROM_ABI constexpr __sentinel<true> end() const
  95. requires range<const _View> && __regular_invocable_with_range_ref<const _Fn&, const _View>
  96. {
  97. return __sentinel<true>(ranges::end(__base_));
  98. }
  99. _LIBCPP_HIDE_FROM_ABI constexpr __iterator<true> end() const
  100. requires common_range<const _View> && __regular_invocable_with_range_ref<const _Fn&, const _View>
  101. {
  102. return __iterator<true>(*this, ranges::end(__base_));
  103. }
  104. _LIBCPP_HIDE_FROM_ABI constexpr auto size()
  105. requires sized_range<_View>
  106. {
  107. return ranges::size(__base_);
  108. }
  109. _LIBCPP_HIDE_FROM_ABI constexpr auto size() const
  110. requires sized_range<const _View>
  111. {
  112. return ranges::size(__base_);
  113. }
  114. };
  115. template <class _Range, class _Fn>
  116. transform_view(_Range&&, _Fn) -> transform_view<views::all_t<_Range>, _Fn>;
  117. template <class _View>
  118. struct __transform_view_iterator_concept {
  119. using type = input_iterator_tag;
  120. };
  121. template <random_access_range _View>
  122. struct __transform_view_iterator_concept<_View> {
  123. using type = random_access_iterator_tag;
  124. };
  125. template <bidirectional_range _View>
  126. struct __transform_view_iterator_concept<_View> {
  127. using type = bidirectional_iterator_tag;
  128. };
  129. template <forward_range _View>
  130. struct __transform_view_iterator_concept<_View> {
  131. using type = forward_iterator_tag;
  132. };
  133. template <class, class>
  134. struct __transform_view_iterator_category_base {};
  135. template <forward_range _View, class _Fn>
  136. struct __transform_view_iterator_category_base<_View, _Fn> {
  137. using _Cat = typename iterator_traits<iterator_t<_View>>::iterator_category;
  138. using iterator_category =
  139. conditional_t< is_reference_v<invoke_result_t<_Fn&, range_reference_t<_View>>>,
  140. conditional_t< derived_from<_Cat, contiguous_iterator_tag>, random_access_iterator_tag, _Cat >,
  141. input_iterator_tag >;
  142. };
  143. # if _LIBCPP_STD_VER >= 23
  144. template <input_range _View, move_constructible _Fn>
  145. # else
  146. template <input_range _View, copy_constructible _Fn>
  147. # endif
  148. requires __transform_view_constraints<_View, _Fn>
  149. template <bool _Const>
  150. class transform_view<_View, _Fn>::__iterator : public __transform_view_iterator_category_base<_View, _Fn> {
  151. using _Parent = __maybe_const<_Const, transform_view>;
  152. using _Base = __maybe_const<_Const, _View>;
  153. _Parent* __parent_ = nullptr;
  154. template <bool>
  155. friend class transform_view<_View, _Fn>::__iterator;
  156. template <bool>
  157. friend class transform_view<_View, _Fn>::__sentinel;
  158. public:
  159. iterator_t<_Base> __current_ = iterator_t<_Base>();
  160. using iterator_concept = typename __transform_view_iterator_concept<_View>::type;
  161. using value_type = remove_cvref_t<invoke_result_t<_Fn&, range_reference_t<_Base>>>;
  162. using difference_type = range_difference_t<_Base>;
  163. _LIBCPP_HIDE_FROM_ABI __iterator()
  164. requires default_initializable<iterator_t<_Base>>
  165. = default;
  166. _LIBCPP_HIDE_FROM_ABI constexpr __iterator(_Parent& __parent, iterator_t<_Base> __current)
  167. : __parent_(std::addressof(__parent)), __current_(std::move(__current)) {}
  168. // Note: `__i` should always be `__iterator<false>`, but directly using
  169. // `__iterator<false>` is ill-formed when `_Const` is false
  170. // (see http://wg21.link/class.copy.ctor#5).
  171. _LIBCPP_HIDE_FROM_ABI constexpr __iterator(__iterator<!_Const> __i)
  172. requires _Const && convertible_to<iterator_t<_View>, iterator_t<_Base>>
  173. : __parent_(__i.__parent_), __current_(std::move(__i.__current_)) {}
  174. _LIBCPP_HIDE_FROM_ABI constexpr const iterator_t<_Base>& base() const& noexcept { return __current_; }
  175. _LIBCPP_HIDE_FROM_ABI constexpr iterator_t<_Base> base() && { return std::move(__current_); }
  176. _LIBCPP_HIDE_FROM_ABI constexpr decltype(auto) operator*() const
  177. noexcept(noexcept(std::invoke(*__parent_->__func_, *__current_))) {
  178. return std::invoke(*__parent_->__func_, *__current_);
  179. }
  180. _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator++() {
  181. ++__current_;
  182. return *this;
  183. }
  184. _LIBCPP_HIDE_FROM_ABI constexpr void operator++(int) { ++__current_; }
  185. _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator++(int)
  186. requires forward_range<_Base>
  187. {
  188. auto __tmp = *this;
  189. ++*this;
  190. return __tmp;
  191. }
  192. _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator--()
  193. requires bidirectional_range<_Base>
  194. {
  195. --__current_;
  196. return *this;
  197. }
  198. _LIBCPP_HIDE_FROM_ABI constexpr __iterator operator--(int)
  199. requires bidirectional_range<_Base>
  200. {
  201. auto __tmp = *this;
  202. --*this;
  203. return __tmp;
  204. }
  205. _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator+=(difference_type __n)
  206. requires random_access_range<_Base>
  207. {
  208. __current_ += __n;
  209. return *this;
  210. }
  211. _LIBCPP_HIDE_FROM_ABI constexpr __iterator& operator-=(difference_type __n)
  212. requires random_access_range<_Base>
  213. {
  214. __current_ -= __n;
  215. return *this;
  216. }
  217. _LIBCPP_HIDE_FROM_ABI constexpr decltype(auto) operator[](difference_type __n) const
  218. noexcept(noexcept(std::invoke(*__parent_->__func_, __current_[__n])))
  219. requires random_access_range<_Base>
  220. {
  221. return std::invoke(*__parent_->__func_, __current_[__n]);
  222. }
  223. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator& __x, const __iterator& __y)
  224. requires equality_comparable<iterator_t<_Base>>
  225. {
  226. return __x.__current_ == __y.__current_;
  227. }
  228. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator<(const __iterator& __x, const __iterator& __y)
  229. requires random_access_range<_Base>
  230. {
  231. return __x.__current_ < __y.__current_;
  232. }
  233. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator>(const __iterator& __x, const __iterator& __y)
  234. requires random_access_range<_Base>
  235. {
  236. return __x.__current_ > __y.__current_;
  237. }
  238. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator<=(const __iterator& __x, const __iterator& __y)
  239. requires random_access_range<_Base>
  240. {
  241. return __x.__current_ <= __y.__current_;
  242. }
  243. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator>=(const __iterator& __x, const __iterator& __y)
  244. requires random_access_range<_Base>
  245. {
  246. return __x.__current_ >= __y.__current_;
  247. }
  248. _LIBCPP_HIDE_FROM_ABI friend constexpr auto operator<=>(const __iterator& __x, const __iterator& __y)
  249. requires random_access_range<_Base> && three_way_comparable<iterator_t<_Base>>
  250. {
  251. return __x.__current_ <=> __y.__current_;
  252. }
  253. _LIBCPP_HIDE_FROM_ABI friend constexpr __iterator operator+(__iterator __i, difference_type __n)
  254. requires random_access_range<_Base>
  255. {
  256. return __iterator{*__i.__parent_, __i.__current_ + __n};
  257. }
  258. _LIBCPP_HIDE_FROM_ABI friend constexpr __iterator operator+(difference_type __n, __iterator __i)
  259. requires random_access_range<_Base>
  260. {
  261. return __iterator{*__i.__parent_, __i.__current_ + __n};
  262. }
  263. _LIBCPP_HIDE_FROM_ABI friend constexpr __iterator operator-(__iterator __i, difference_type __n)
  264. requires random_access_range<_Base>
  265. {
  266. return __iterator{*__i.__parent_, __i.__current_ - __n};
  267. }
  268. _LIBCPP_HIDE_FROM_ABI friend constexpr difference_type operator-(const __iterator& __x, const __iterator& __y)
  269. requires sized_sentinel_for<iterator_t<_Base>, iterator_t<_Base>>
  270. {
  271. return __x.__current_ - __y.__current_;
  272. }
  273. _LIBCPP_HIDE_FROM_ABI friend constexpr decltype(auto) iter_move(const __iterator& __i) noexcept(noexcept(*__i)) {
  274. if constexpr (is_lvalue_reference_v<decltype(*__i)>)
  275. return std::move(*__i);
  276. else
  277. return *__i;
  278. }
  279. };
  280. # if _LIBCPP_STD_VER >= 23
  281. template <input_range _View, move_constructible _Fn>
  282. # else
  283. template <input_range _View, copy_constructible _Fn>
  284. # endif
  285. requires __transform_view_constraints<_View, _Fn>
  286. template <bool _Const>
  287. class transform_view<_View, _Fn>::__sentinel {
  288. using _Parent = __maybe_const<_Const, transform_view>;
  289. using _Base = __maybe_const<_Const, _View>;
  290. sentinel_t<_Base> __end_ = sentinel_t<_Base>();
  291. template <bool>
  292. friend class transform_view<_View, _Fn>::__iterator;
  293. template <bool>
  294. friend class transform_view<_View, _Fn>::__sentinel;
  295. public:
  296. _LIBCPP_HIDE_FROM_ABI __sentinel() = default;
  297. _LIBCPP_HIDE_FROM_ABI constexpr explicit __sentinel(sentinel_t<_Base> __end) : __end_(__end) {}
  298. // Note: `__i` should always be `__sentinel<false>`, but directly using
  299. // `__sentinel<false>` is ill-formed when `_Const` is false
  300. // (see http://wg21.link/class.copy.ctor#5).
  301. _LIBCPP_HIDE_FROM_ABI constexpr __sentinel(__sentinel<!_Const> __i)
  302. requires _Const && convertible_to<sentinel_t<_View>, sentinel_t<_Base>>
  303. : __end_(std::move(__i.__end_)) {}
  304. _LIBCPP_HIDE_FROM_ABI constexpr sentinel_t<_Base> base() const { return __end_; }
  305. template <bool _OtherConst>
  306. requires sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
  307. _LIBCPP_HIDE_FROM_ABI friend constexpr bool operator==(const __iterator<_OtherConst>& __x, const __sentinel& __y) {
  308. return __x.__current_ == __y.__end_;
  309. }
  310. template <bool _OtherConst>
  311. requires sized_sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
  312. _LIBCPP_HIDE_FROM_ABI friend constexpr range_difference_t<__maybe_const<_OtherConst, _View>>
  313. operator-(const __iterator<_OtherConst>& __x, const __sentinel& __y) {
  314. return __x.__current_ - __y.__end_;
  315. }
  316. template <bool _OtherConst>
  317. requires sized_sentinel_for<sentinel_t<_Base>, iterator_t<__maybe_const<_OtherConst, _View>>>
  318. _LIBCPP_HIDE_FROM_ABI friend constexpr range_difference_t<__maybe_const<_OtherConst, _View>>
  319. operator-(const __sentinel& __x, const __iterator<_OtherConst>& __y) {
  320. return __x.__end_ - __y.__current_;
  321. }
  322. };
  323. namespace views {
  324. namespace __transform {
  325. struct __fn {
  326. template <class _Range, class _Fn>
  327. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto operator()(_Range&& __range, _Fn&& __f) const
  328. noexcept(noexcept(transform_view(std::forward<_Range>(__range), std::forward<_Fn>(__f))))
  329. -> decltype(transform_view(std::forward<_Range>(__range), std::forward<_Fn>(__f))) {
  330. return transform_view(std::forward<_Range>(__range), std::forward<_Fn>(__f));
  331. }
  332. template <class _Fn>
  333. requires constructible_from<decay_t<_Fn>, _Fn>
  334. [[nodiscard]] _LIBCPP_HIDE_FROM_ABI constexpr auto operator()(_Fn&& __f) const
  335. noexcept(is_nothrow_constructible_v<decay_t<_Fn>, _Fn>) {
  336. return __range_adaptor_closure_t(std::__bind_back(*this, std::forward<_Fn>(__f)));
  337. }
  338. };
  339. } // namespace __transform
  340. inline namespace __cpo {
  341. inline constexpr auto transform = __transform::__fn{};
  342. } // namespace __cpo
  343. } // namespace views
  344. } // namespace ranges
  345. #endif // _LIBCPP_STD_VER >= 20
  346. _LIBCPP_END_NAMESPACE_STD
  347. _LIBCPP_POP_MACROS
  348. #endif // _LIBCPP___RANGES_TRANSFORM_VIEW_H