Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Struct template extractor

boost::accumulators::extractor — Extracts the result associated with Feature from the specified accumulator_set.

Synopsis

// In header: <boost/accumulators/framework/extractor.hpp>

template<typename Feature> 
struct extractor {
  // types
  typedef extractor<  ;

  // member classes/structs/unions

  // The result meta-function for determining the return type of the
  // extractor.
  template<typename F> 
  struct result {
  };
  template<typename A1> 
  struct result<> {
  };

  // public member functions
  template<typename Arg1>  () ;
  template<typename AccumulatorSet, typename A1> 
     (, ) ;
  template<typename AccumulatorSet, typename A1, typename A2, ... > 
     (, , , 
                           ...);
};

Description

extractor public member functions

  1. template<typename Arg1>  ( arg1) ;

    Extract the result associated with Feature from the accumulator set

  2. template<typename AccumulatorSet, typename A1> 
       ( acc,  a1) ;

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

    Parameters:

    a1

    Optional named parameter to be passed to the accumulator's result() function.

  3. template<typename AccumulatorSet, typename A1, typename A2, ... > 
       ( acc,  a1, 
                              a2, ...);

    This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.


PrevUpHomeNext