Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight > Struct Template Reference

Peaks over Threshold Method for Quantile and Tail Mean Estimation. More...

#include <statistics_fwd.hpp>

Inheritance diagram for boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >:
Collaboration diagram for boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >:

Public Types

typedef
numeric::functional::fdiv
< 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
 
typedef mpl::false_ is_droppable
 

Public Member Functions

template<typename Args >
 peaks_over_threshold_prob_impl (Args const &args)
 
void operator() (dont_care)
 
template<typename Args >
result_type result (Args const &args) const
 
detail::void_ add_ref (dont_care)
 
detail::void_ drop (dont_care)
 
detail::void_ on_drop (dont_care)
 

Detailed Description

template<typename Sample, typename LeftRight>
struct boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >

Peaks over Threshold Method for Quantile and Tail Mean Estimation.

See also
peaks_over_threshold_impl
Parameters
quantile_probability
pot_threshold_probability

Member Typedef Documentation

template<typename Sample , typename LeftRight >
typedef numeric::functional::fdiv<Sample, std::size_t>::result_type boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >::float_type
template<typename Sample , typename LeftRight >
typedef boost::tuple<float_type, float_type, float_type> boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >::result_type
template<typename Sample , typename LeftRight >
typedef mpl::int_<is_same<LeftRight, left>::value ? -1 : 1> boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >::sign

Constructor & Destructor Documentation

template<typename Sample , typename LeftRight >
template<typename Args >
boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >::peaks_over_threshold_prob_impl ( Args const &  args)
inline

Member Function Documentation

detail::void_ boost::accumulators::accumulator_base::add_ref ( dont_care  )
inlineinherited
detail::void_ boost::accumulators::accumulator_base::drop ( dont_care  )
inlineinherited
detail::void_ boost::accumulators::accumulator_base::on_drop ( dont_care  )
inlineinherited
template<typename Sample , typename LeftRight >
void boost::accumulators::impl::peaks_over_threshold_prob_impl< Sample, LeftRight >::operator() ( dont_care  )
inline

The documentation for this struct was generated from the following file: