Struct template peaks_over_threshold_prob_impl

| Home | Libraries | People | FAQ | More

## Struct template peaks_over_threshold_prob_impl

boost::accumulators::impl::peaks_over_threshold_prob_impl — Peaks over Threshold Method for Quantile and Tail Mean Estimation.

## Synopsis

    template<typename Sample, typename LeftRight>
    struct peaks_over_threshold_prob_impl {
      // types
      typedef numeric::functional::average< Sample, std::size_t >::result_type float_type;
      typedef boost::tuple< float_type, float_type, float_type >               result_type;
      typedef mpl::int_< is_same< LeftRight, left >::value?-1:1 >              sign;

      // construct/copy/destruct
      template<typename Args> peaks_over_threshold_prob_impl(Args const &);

      // public member functions
      void operator()(dont_care) ;
      template<typename Args> result_type result(Args const &) const;
    };

## Description

peaks_over_threshold_impl

### `peaks_over_threshold_prob_impl` public construct/copy/destruct

1.     template<typename Args> peaks_over_threshold_prob_impl(Args const & args);

### `peaks_over_threshold_prob_impl` public member functions

1.     void operator()(dont_care) ;

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