boost/accumulators/accumulators_fwd.hpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // accumulators_fwd.hpp
   3 //
   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)
   7
   8 #ifndef BOOST_ACCUMULATORS_ACCUMULATORS_FWD_HPP_EAN_28_10_2005
   9 #define BOOST_ACCUMULATORS_ACCUMULATORS_FWD_HPP_EAN_28_10_2005
  10
  11 #include <boost/config.hpp>
  12 #include <boost/mpl/apply_fwd.hpp> // for mpl::na
  13 #include <boost/mpl/limits/vector.hpp>
  14 #include <boost/preprocessor/arithmetic/inc.hpp>
  15 #include <boost/preprocessor/repetition/enum_params_with_a_default.hpp>
  16 #include <boost/preprocessor/repetition/enum_trailing_params.hpp>
  17 #include <boost/preprocessor/repetition/enum_trailing_binary_params.hpp>
  18 #include <boost/preprocessor/repetition/repeat_from_to.hpp>
  19 #include <boost/accumulators/numeric/functional_fwd.hpp>
  20
  21 #ifndef BOOST_ACCUMULATORS_MAX_FEATURES
  22   /// The maximum number of accumulators that may be put in an accumulator_set.
  23   /// Defaults to BOOST_MPL_LIMIT_VECTOR_SIZE (which defaults to 20).
  24 # define BOOST_ACCUMULATORS_MAX_FEATURES BOOST_MPL_LIMIT_VECTOR_SIZE
  25 #endif
  26
  27 #if BOOST_ACCUMULATORS_MAX_FEATURES > BOOST_MPL_LIMIT_VECTOR_SIZE
  28 # error BOOST_ACCUMULATORS_MAX_FEATURES cannot be larger than BOOST_MPL_LIMIT_VECTOR_SIZE
  29 #endif
  30
  31 #ifndef BOOST_ACCUMULATORS_MAX_ARGS
  32   /// The maximum number of arguments that may be specified to an accumulator_set's
  33   /// accumulation function. Defaults to 15.
  34 # define BOOST_ACCUMULATORS_MAX_ARGS 15
  35 #endif
  36
  37 #if BOOST_WORKAROUND(__GNUC__, == 3) \
  38  || BOOST_WORKAROUND(__EDG_VERSION__, BOOST_TESTED_AT(306))
  39 # define BOOST_ACCUMULATORS_BROKEN_CONST_OVERLOADS
  40 #endif
  41
  42 #ifdef BOOST_ACCUMULATORS_BROKEN_CONST_OVERLOADS
  43 # include <boost/utility/enable_if.hpp>
  44 # include <boost/type_traits/is_const.hpp>
  45 # define BOOST_ACCUMULATORS_PROTO_DISABLE_IF_IS_CONST(T)\
  46     , typename boost::disable_if<boost::is_const<T> >::type * = 0
  47 #else
  48 # define BOOST_ACCUMULATORS_PROTO_DISABLE_IF_IS_CONST(T)
  49 #endif
  50
  51 namespace boost { namespace accumulators
  52 {
  53
  54 ///////////////////////////////////////////////////////////////////////////////
  55 // Named parameters tags
  56 //
  57 namespace tag
  58 {
  59     struct sample;
  60     struct weight;
  61     struct accumulator;
  62     struct weights;
  63 }
  64
  65 ///////////////////////////////////////////////////////////////////////////////
  66 // User-level features
  67 //
  68 namespace tag
  69 {
  70     template<typename ValueType, typename Tag>
  71     struct value;
  72
  73     template<typename Tag>
  74     struct value_tag;
  75
  76     template<typename Referent, typename Tag>
  77     struct reference;
  78
  79     template<typename Tag>
  80     struct reference_tag;
  81
  82     template<typename Type, typename Tag = void, typename AccumulatorSet = void>
  83     struct external;
  84
  85     template<typename Feature>
  86     struct droppable;
  87 }
  88
  89 template<typename Accumulator>
  90 struct droppable_accumulator_base;
  91
  92 template<typename Accumulator>
  93 struct droppable_accumulator;
  94
  95 template<typename Accumulator>
  96 struct with_cached_result;
  97
  98 template<typename Sample, typename Features, typename Weight = void>
  99 struct accumulator_set;
 100
 101 template<typename Feature>
 102 struct extractor;
 103
 104 template<typename Feature>
 105 struct feature_of;
 106
 107 template<typename Feature>
 108 struct as_feature;
 109
 110 template<typename Feature>
 111 struct as_weighted_feature;
 112
 113 template<BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT(BOOST_ACCUMULATORS_MAX_FEATURES, typename Feature, mpl::na)>
 114 struct depends_on;
 115
 116 template<BOOST_PP_ENUM_PARAMS_WITH_A_DEFAULT(BOOST_ACCUMULATORS_MAX_FEATURES, typename Feature, mpl::na)>
 117 struct features;
 118
 119 template<typename Feature, typename AccumulatorSet>
 120 typename mpl::apply<AccumulatorSet, Feature>::type const &
 121 find_accumulator(AccumulatorSet const &acc);
 122
 123 template<typename Feature, typename AccumulatorSet>
 124 typename mpl::apply<AccumulatorSet, Feature>::type::result_type
 125 extract_result(AccumulatorSet const &acc);
 126
 127 template<typename Feature, typename AccumulatorSet, typename A1>
 128 typename mpl::apply<AccumulatorSet, Feature>::type::result_type
 129 extract_result(AccumulatorSet const &acc, A1 const &a1);
 130
 131 // ... other overloads generated by Boost.Preprocessor:
 132
 133 /// INTERNAL ONLY
 134 ///
 135 #define BOOST_ACCUMULATORS_EXTRACT_RESULT_FWD(z, n, _)                      \
 136     template<                                                               \
 137         typename Feature                                                    \
 138       , typename AccumulatorSet                                             \
 139         BOOST_PP_ENUM_TRAILING_PARAMS_Z(z, n, typename A)                   \
 140     >                                                                       \
 141     typename mpl::apply<AccumulatorSet, Feature>::type::result_type         \
 142     extract_result(                                                         \
 143         AccumulatorSet const &acc                                           \
 144         BOOST_PP_ENUM_TRAILING_BINARY_PARAMS_Z(z, n, A, const &a)           \
 145     );
 146
 147 /// INTERNAL ONLY
 148 ///
 149 BOOST_PP_REPEAT_FROM_TO(
 150     2
 151   , BOOST_PP_INC(BOOST_ACCUMULATORS_MAX_ARGS)
 152   , BOOST_ACCUMULATORS_EXTRACT_RESULT_FWD
 153   , _
 154 )
 155
 156 #ifdef BOOST_ACCUMULATORS_DOXYGEN_INVOKED
 157 template<typename Feature, typename AccumulatorSet, typename A1, typename A2 ...>
 158 typename mpl::apply<AccumulatorSet, Feature>::type::result_type
 159 extract_result(AccumulatorSet const &acc, A1 const &a1, A2 const &a2 ...);
 160 #endif
 161
 162 namespace impl
 163 {
 164     using namespace numeric::operators;
 165
 166     template<typename Accumulator, typename Tag>
 167     struct external_impl;
 168 }
 169
 170 namespace detail
 171 {
 172     template<typename Accumulator>
 173     struct feature_tag;
 174
 175     template<typename Feature, typename Sample, typename Weight>
 176     struct to_accumulator;
 177
 178     struct accumulator_set_base;
 179
 180     template<typename T>
 181     struct is_accumulator_set;
 182 }
 183
 184 }} // namespace boost::accumulators
 185
 186 // For defining boost::parameter keywords that can be inherited from to
 187 // get a nested, class-scoped keyword with the requested alias
 188 #define BOOST_PARAMETER_NESTED_KEYWORD(tag_namespace, name, alias)                                  \
 189     namespace tag_namespace                                                                         \
 190     {                                                                                               \
 191         template<int Dummy = 0>                                                                     \
 192         struct name ## _                                                                            \
 193         {                                                                                           \
 194             static char const* keyword_name()                                                       \
 195             {                                                                                       \
 196                 return #name;                                                                       \
 197             }                                                                                       \
 198             static ::boost::parameter::keyword<name ## _<Dummy> > &alias;                           \
 199         };                                                                                          \
 200         template<int Dummy>                                                                         \
 201         ::boost::parameter::keyword<name ## _<Dummy> > &name ## _<Dummy>::alias =                   \
 202         ::boost::parameter::keyword<name ## _<Dummy> >::get();                                      \
 203         typedef name ## _ <> name;                                                                  \
 204     }                                                                                               \
 205     namespace                                                                                       \
 206     {                                                                                               \
 207         ::boost::parameter::keyword<tag_namespace::name> &name =                                    \
 208         ::boost::parameter::keyword<tag_namespace::name>::get();                                    \
 209     }
 210
 211 #endif