1 ///////////////////////////////////////////////////////////////////////////////
4 // Copyright 2005 Eric Niebler. Distributed under the Boost
5 // Software License, Version 1.0. (See accompanying file
6 // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
8 #ifndef BOOST_ACCUMULATORS_FRAMEWORK_EXTRACTOR_HPP_EAN_28_10_2005
9 #define BOOST_ACCUMULATORS_FRAMEWORK_EXTRACTOR_HPP_EAN_28_10_2005
11 #include <boost/preprocessor/tuple/rem.hpp>
12 #include <boost/preprocessor/array/size.hpp>
13 #include <boost/preprocessor/array/data.hpp>
14 #include <boost/preprocessor/array/elem.hpp>
15 #include <boost/preprocessor/seq/to_array.hpp>
16 #include <boost/preprocessor/seq/transform.hpp>
17 #include <boost/preprocessor/repetition/enum_params.hpp>
18 #include <boost/preprocessor/repetition/enum_trailing_params.hpp>
19 #include <boost/preprocessor/repetition/enum_trailing_binary_params.hpp>
20 #include <boost/parameter/binding.hpp>
21 #include <boost/mpl/apply.hpp>
22 #include <boost/mpl/eval_if.hpp>
23 #include <boost/type_traits/remove_reference.hpp>
24 #include <boost/accumulators/accumulators_fwd.hpp>
25 #include <boost/accumulators/framework/parameters/accumulator.hpp>
27 namespace boost { namespace accumulators
32 template<typename AccumulatorSet, typename Feature>
33 struct accumulator_set_result
35 typedef typename as_feature<Feature>::type feature_type;
36 typedef typename mpl::apply<AccumulatorSet, feature_type>::type::result_type type;
39 template<typename Args, typename Feature>
40 struct argument_pack_result
41 : accumulator_set_result<
42 typename remove_reference<
43 typename parameter::binding<Args, tag::accumulator>::type
50 template<typename A, typename Feature>
51 struct extractor_result
53 detail::is_accumulator_set<A>
54 , accumulator_set_result<A, Feature>
55 , argument_pack_result<A, Feature>
60 template<typename Feature, typename AccumulatorSet>
61 typename extractor_result<AccumulatorSet, Feature>::type
62 do_extract(AccumulatorSet const &acc, mpl::true_)
64 typedef typename as_feature<Feature>::type feature_type;
65 return extract_result<feature_type>(acc);
68 template<typename Feature, typename Args>
69 typename extractor_result<Args, Feature>::type
70 do_extract(Args const &args, mpl::false_)
72 typedef typename as_feature<Feature>::type feature_type;
73 return find_accumulator<feature_type>(args[accumulator]).result(args);
79 ///////////////////////////////////////////////////////////////////////////////
80 /// Extracts the result associated with Feature from the specified accumulator_set.
81 template<typename Feature>
84 typedef extractor<Feature> this_type;
86 /// The result meta-function for determining the return type of the extractor
91 struct result<this_type(A1)>
92 : detail::extractor_result<A1, Feature>
96 /// Extract the result associated with Feature from the accumulator set
97 /// \param acc The accumulator set object from which to extract the result
98 template<typename Arg1>
99 typename detail::extractor_result<Arg1, Feature>::type
100 operator ()(Arg1 const &arg1) const
102 // Arg1 could be an accumulator_set or an argument pack containing
103 // an accumulator_set. Dispatch accordingly.
104 return detail::do_extract<Feature>(arg1, detail::is_accumulator_set<Arg1>());
109 /// \param a1 Optional named parameter to be passed to the accumulator's result() function.
110 template<typename AccumulatorSet, typename A1>
111 typename detail::extractor_result<AccumulatorSet, Feature>::type
112 operator ()(AccumulatorSet const &acc, A1 const &a1) const
114 BOOST_MPL_ASSERT((detail::is_accumulator_set<AccumulatorSet>));
115 typedef typename as_feature<Feature>::type feature_type;
116 return extract_result<feature_type>(acc, a1);
119 // ... other overloads generated by Boost.Preprocessor:
123 #define BOOST_ACCUMULATORS_EXTRACTOR_FUN_OP(z, n, _) \
124 template<BOOST_PP_ENUM_PARAMS_Z(z, n, typename A)> \
125 struct result<this_type(BOOST_PP_ENUM_PARAMS_Z(z, n, A))> \
126 : detail::extractor_result<A1, Feature> \
129 typename AccumulatorSet \
130 BOOST_PP_ENUM_TRAILING_PARAMS_Z(z, n, typename A) \
132 typename detail::extractor_result<AccumulatorSet, Feature>::type \
134 AccumulatorSet const &acc \
135 BOOST_PP_ENUM_TRAILING_BINARY_PARAMS_Z(z, n, A, const &a) \
138 BOOST_MPL_ASSERT((detail::is_accumulator_set<AccumulatorSet>)); \
139 typedef typename as_feature<Feature>::type feature_type; \
140 return extract_result<feature_type>(acc BOOST_PP_ENUM_TRAILING_PARAMS_Z(z, n, a));\
143 BOOST_PP_REPEAT_FROM_TO(
145 , BOOST_PP_INC(BOOST_ACCUMULATORS_MAX_ARGS)
146 , BOOST_ACCUMULATORS_EXTRACTOR_FUN_OP
150 #ifdef BOOST_ACCUMULATORS_DOXYGEN_INVOKED
153 template<typename AccumulatorSet, typename A1, typename A2, ...>
154 typename detail::extractor_result<AccumulatorSet, Feature>::type
155 operator ()(AccumulatorSet const &acc, A1 const &a1, A2 const &a2, ...);
161 #define BOOST_ACCUMULATORS_ARRAY_REM(Array) \
162 BOOST_PP_TUPLE_REM_CTOR(BOOST_PP_ARRAY_SIZE(Array), BOOST_PP_ARRAY_DATA(Array))
166 #define BOOST_ACCUMULATORS_SEQ_REM(Seq) \
167 BOOST_ACCUMULATORS_ARRAY_REM(BOOST_PP_SEQ_TO_ARRAY(Seq))
171 #define BOOST_ACCUMULATORS_ARGS_OP(s, data, elem) \
176 #define BOOST_ACCUMULATORS_PARAMS_OP(s, data, elem) \
181 #define BOOST_ACCUMULATORS_MAKE_FEATURE(Tag, Feature, ParamsSeq) \
183 BOOST_ACCUMULATORS_SEQ_REM( \
184 BOOST_PP_SEQ_TRANSFORM(BOOST_ACCUMULATORS_ARGS_OP, ~, ParamsSeq) \
190 #define BOOST_ACCUMULATORS_DEFINE_EXTRACTOR_FUN_IMPL(z, n, Tag, Feature, ParamsSeq) \
192 BOOST_ACCUMULATORS_SEQ_REM( \
193 BOOST_PP_SEQ_TRANSFORM(BOOST_ACCUMULATORS_PARAMS_OP, ~, ParamsSeq) \
196 BOOST_PP_ENUM_TRAILING_PARAMS_Z(z, n, typename A) \
198 typename boost::accumulators::detail::extractor_result< \
200 , BOOST_ACCUMULATORS_MAKE_FEATURE(Tag, Feature, ParamsSeq) \
202 Feature(Arg1 const &arg1 BOOST_PP_ENUM_TRAILING_BINARY_PARAMS_Z(z, n, A, const &a) ) \
204 typedef BOOST_ACCUMULATORS_MAKE_FEATURE(Tag, Feature, ParamsSeq) feature_type; \
205 return boost::accumulators::extractor<feature_type>()( \
206 arg1 BOOST_PP_ENUM_TRAILING_PARAMS_Z(z, n, a)); \
211 #define BOOST_ACCUMULATORS_DEFINE_EXTRACTOR_FUN(z, n, _) \
212 BOOST_ACCUMULATORS_DEFINE_EXTRACTOR_FUN_IMPL( \
215 , BOOST_PP_ARRAY_ELEM(0, _) \
216 , BOOST_PP_ARRAY_ELEM(1, _) \
217 , BOOST_PP_ARRAY_ELEM(2, _) \
220 #define BOOST_ACCUMULATORS_DEFINE_EXTRACTOR(Tag, Feature, ParamSeq) \
222 BOOST_PP_INC(BOOST_ACCUMULATORS_MAX_ARGS) \
223 , BOOST_ACCUMULATORS_DEFINE_EXTRACTOR_FUN \
224 , (3, (Tag, Feature, ParamSeq)) \
227 }} // namespace boost::accumulators