Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. — Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

This is the documentation for a snapshot of the develop branch, built from commit 2d0168b68b.

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< Feature > this_type;

  // 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<this_type(A1)> {
  };

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

Description

`extractor` public member functions

template<typename Arg1> unspecified operator()(Arg1 const & arg1) const;

Extract the result associated with Feature from the accumulator set

```
template<typename AccumulatorSet, typename A1> 
  unspecified operator()(AccumulatorSet const & acc, A1 const & a1) const;
```
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.

template<typename AccumulatorSet, typename A1, typename A2, ... > 
  unspecified operator()(AccumulatorSet const & acc, A1 const & a1, 
                         A2 const & a2, ...);

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