STR(3)

NAME
boost::accumulators::impl::weighted_peaks_over_threshold_impl - Weighted Peaks over Threshold Method for Weighted Quantile and Weighted Tail Mean Estimation.

SYNOPSIS

// In header: <boost/accumulators/statistics/weighted_peaks_over_threshold.hpp>
template<typename Sample, typename Weight, typename LeftRight>
struct weighted_peaks_over_threshold_impl {
  // types
  typedef numeric::functional::multiplies< Weight, Sample >::result_type            weighted_sample;
  typedef numeric::functional::average< weighted_sample, std::size_t >::result_type float_type;
  typedef boost::tuple< float_type, float_type, float_type >                        result_type;
  // construct/copy/destruct
  template<typename Args> weighted_peaks_over_threshold_impl(Args const &);
  // public member functions
  template<typename Args> void operator()(Args const &);
  template<typename Args> result_type result(Args const &) const;
};

DESCRIPTION

  weighted_peaks_over_threshold_impl public construct/copy/destruct

    1.

    template<typename Args> weighted_peaks_over_threshold_impl(Args const & args);

  weighted_peaks_over_threshold_impl public member functions

    1.

    template<typename Args> void operator()(Args const & args);

    2.

    template<typename Args> result_type result(Args const & args) const;