partial_sum.hpp 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. /// \file
  2. // Range v3 library
  3. //
  4. // Copyright Eric Niebler 2013-present
  5. //
  6. // Use, modification and distribution is subject to the
  7. // Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at
  9. // http://www.boost.org/LICENSE_1_0.txt)
  10. //
  11. // Project home: https://github.com/ericniebler/range-v3
  12. //
  13. #ifndef RANGES_V3_VIEW_PARTIAL_SUM_HPP
  14. #define RANGES_V3_VIEW_PARTIAL_SUM_HPP
  15. #include <iterator>
  16. #include <type_traits>
  17. #include <utility>
  18. #include <meta/meta.hpp>
  19. #include <range/v3/range_fwd.hpp>
  20. #include <range/v3/functional/arithmetic.hpp>
  21. #include <range/v3/functional/bind_back.hpp>
  22. #include <range/v3/functional/invoke.hpp>
  23. #include <range/v3/range/access.hpp>
  24. #include <range/v3/range/primitives.hpp>
  25. #include <range/v3/range/traits.hpp>
  26. #include <range/v3/utility/addressof.hpp>
  27. #include <range/v3/utility/semiregular_box.hpp>
  28. #include <range/v3/utility/static_const.hpp>
  29. #include <range/v3/view/all.hpp>
  30. #include <range/v3/view/facade.hpp>
  31. #include <range/v3/view/view.hpp>
  32. #include <range/v3/detail/prologue.hpp>
  33. namespace ranges
  34. {
  35. /// \cond
  36. namespace detail
  37. {
  38. // clang-format off
  39. /// \concept partial_sum_view_constraints_
  40. /// \brief The \c partial_sum_view_constraints_ concept
  41. template(typename Rng, typename Fun)(
  42. concept (partial_sum_view_constraints_)(Rng, Fun),
  43. copy_constructible<range_value_t<Rng>> AND
  44. constructible_from<range_value_t<Rng>, range_reference_t<Rng>> AND
  45. assignable_from<range_value_t<Rng> &, range_reference_t<Rng>> AND
  46. indirectly_binary_invocable_<Fun &, iterator_t<Rng>, iterator_t<Rng>> AND
  47. assignable_from<
  48. range_value_t<Rng> &,
  49. indirect_result_t<Fun &, iterator_t<Rng>, iterator_t<Rng>>>
  50. );
  51. /// \concept partial_sum_view_constraints
  52. /// \brief The \c partial_sum_view_constraints concept
  53. template<typename Rng, typename Fun>
  54. CPP_concept partial_sum_view_constraints =
  55. input_range<Rng> &&
  56. copy_constructible<Fun> &&
  57. CPP_concept_ref(detail::partial_sum_view_constraints_, Rng, Fun);
  58. // clang-format on
  59. } // namespace detail
  60. /// \endcond
  61. /// \addtogroup group-views
  62. /// @{
  63. template<typename Rng, typename Fun>
  64. struct partial_sum_view
  65. : view_facade<partial_sum_view<Rng, Fun>, range_cardinality<Rng>::value>
  66. {
  67. private:
  68. friend range_access;
  69. CPP_assert(view_<Rng>);
  70. CPP_assert(detail::partial_sum_view_constraints<Rng, Fun>);
  71. RANGES_NO_UNIQUE_ADDRESS Rng base_{};
  72. RANGES_NO_UNIQUE_ADDRESS semiregular_box_t<Fun> fun_;
  73. template<bool IsConst>
  74. struct cursor
  75. {
  76. private:
  77. friend cursor<true>;
  78. using Parent = meta::const_if_c<IsConst, partial_sum_view>;
  79. using Base = meta::const_if_c<IsConst, Rng>;
  80. Parent * parent_ = nullptr;
  81. RANGES_NO_UNIQUE_ADDRESS iterator_t<Base> current_{};
  82. RANGES_NO_UNIQUE_ADDRESS semiregular_box_t<range_value_t<Rng>> sum_;
  83. public:
  84. using single_pass = meta::bool_<single_pass_iterator_<iterator_t<Base>>>;
  85. cursor() = default;
  86. constexpr explicit cursor(Parent * rng)
  87. : parent_{rng}
  88. , current_(ranges::begin(rng->base_))
  89. {
  90. if(current_ != ranges::end(rng->base_))
  91. sum_ = *current_;
  92. }
  93. template(bool Other)(
  94. requires IsConst AND CPP_NOT(Other) AND
  95. convertible_to<iterator_t<Rng> const &,
  96. iterator_t<Base>>)
  97. constexpr cursor(cursor<Other> const & that)
  98. : parent_{that.parent_}
  99. , current_(that.current_)
  100. , sum_(that.sum_)
  101. {}
  102. constexpr range_value_t<Rng> read() const
  103. {
  104. RANGES_EXPECT(current_ != ranges::end(parent_->base_));
  105. return sum_;
  106. }
  107. constexpr void next()
  108. {
  109. auto last = ranges::end(parent_->base_);
  110. RANGES_EXPECT(current_ != last);
  111. if(++current_ != last)
  112. {
  113. auto & sum = static_cast<range_value_t<Rng> &>(sum_);
  114. using F = meta::const_if_c<IsConst, Fun>;
  115. auto & f = static_cast<F &>(parent_->fun_);
  116. sum = invoke(f, sum, *current_);
  117. }
  118. }
  119. constexpr bool equal(default_sentinel_t) const
  120. {
  121. return current_ == ranges::end(parent_->base_);
  122. }
  123. CPP_auto_member
  124. constexpr bool CPP_fun(equal)(cursor const & that)(const //
  125. requires equality_comparable<iterator_t<Base>>)
  126. {
  127. RANGES_EXPECT(parent_ == that.parent_);
  128. return current_ == that.current_;
  129. }
  130. };
  131. constexpr cursor<false> begin_cursor()
  132. {
  133. return cursor<false>{this};
  134. }
  135. template(typename CRng = Rng const)(
  136. requires detail::partial_sum_view_constraints<CRng, Fun const>)
  137. constexpr cursor<true> begin_cursor() const
  138. {
  139. return cursor<true>{this};
  140. }
  141. public:
  142. partial_sum_view() = default;
  143. constexpr partial_sum_view(Rng rng, Fun fun) noexcept(
  144. std::is_nothrow_move_constructible<Rng>::value &&
  145. std::is_nothrow_move_constructible<Fun>::value)
  146. : base_(std::move(rng))
  147. , fun_(std::move(fun))
  148. {}
  149. CPP_auto_member
  150. constexpr auto CPP_fun(size)()(
  151. requires sized_range<Rng>)
  152. {
  153. return ranges::size(base_);
  154. }
  155. CPP_auto_member
  156. constexpr auto CPP_fun(size)()(const //
  157. requires sized_range<Rng const>)
  158. {
  159. return ranges::size(base_);
  160. }
  161. };
  162. #if RANGES_CXX_DEDUCTION_GUIDES >= RANGES_CXX_DEDUCTION_GUIDES_17
  163. template(typename Rng, typename Fun)(
  164. requires copy_constructible<Fun>)
  165. partial_sum_view(Rng &&, Fun)
  166. -> partial_sum_view<views::all_t<Rng>, Fun>;
  167. #endif
  168. namespace views
  169. {
  170. struct partial_sum_base_fn
  171. {
  172. template(typename Rng, typename Fun = plus)(
  173. requires detail::partial_sum_view_constraints<all_t<Rng>, Fun>)
  174. constexpr partial_sum_view<all_t<Rng>, Fun> //
  175. operator()(Rng && rng, Fun fun = {}) const
  176. {
  177. return {all(static_cast<Rng &&>(rng)), std::move(fun)};
  178. }
  179. };
  180. struct partial_sum_fn : partial_sum_base_fn
  181. {
  182. using partial_sum_base_fn::operator();
  183. template(typename Fun)(
  184. requires (!range<Fun>))
  185. constexpr auto operator()(Fun && fun) const
  186. {
  187. return make_view_closure(
  188. bind_back(partial_sum_base_fn{}, static_cast<Fun &&>(fun)));
  189. }
  190. template<typename Fun = plus>
  191. RANGES_DEPRECATED(
  192. "Use \"ranges::views::partial_sum\" instead of "
  193. "\"ranges::views::partial_sum()\".")
  194. constexpr auto
  195. operator()() const
  196. {
  197. return make_view_closure(bind_back(partial_sum_base_fn{}, Fun{}));
  198. }
  199. };
  200. /// \relates partial_sum_fn
  201. /// \ingroup group-views
  202. RANGES_INLINE_VARIABLE(view_closure<partial_sum_fn>, partial_sum)
  203. } // namespace views
  204. /// @}
  205. } // namespace ranges
  206. #include <range/v3/detail/epilogue.hpp>
  207. #include <range/v3/detail/satisfy_boost_range.hpp>
  208. RANGES_SATISFY_BOOST_RANGE(::ranges::partial_sum_view)
  209. #endif