transform_view.h 14 KB

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