Struct template pot_quantile_impl

Boost C++ Libraries

Struct template pot_quantile_impl

boost::accumulators::impl::pot_quantile_impl — Quantile Estimation based on Peaks over Threshold Method (for both left and right tails)

Synopsis

// In header: <boost/accumulators/statistics/pot_quantile.hpp>

template<typename Sample, typename Impl, typename LeftRight> 
struct pot_quantile_impl {
  // types
  typedef numeric::functional::average< Sample, std::size_t >::result_type float_type; 
  typedef float_type                                                       result_type;

  // construct/copy/destruct
  pot_quantile_impl(dont_care);

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

Description

Computes an estimate

Equation 1.9.

for a right or left extreme quantile, , and being the parameters of the generalized Pareto distribution that approximates the right tail of the distribution (or the mirrored left tail, in case the left tail is used). In the latter case, the result is mirrored back, yielding the correct result.

`pot_quantile_impl` public construct/copy/destruct

```
pot_quantile_impl(dont_care);
```

`pot_quantile_impl` public member functions

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