Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature > Struct Template Reference

Lazy calculation of variance. More...

#include <statistics_fwd.hpp>

Inheritance diagram for boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature >:
Inheritance graph
[legend]
Collaboration diagram for boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature >:
Collaboration graph
[legend]

Public Types

typedef
numeric::functional::fdiv
< Sample, std::size_t >
::result_type 		result_type
 
typedef mpl::false_ is_droppable
 

Public Member Functions

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

Detailed Description

template<typename Sample, typename MeanFeature>
struct boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature >

Lazy calculation of variance.

Default sample variance implementation based on the second moment $ M_n^{(2)} $ moment<2>, mean and count.

\[ \sigma_n^2 = M_n^{(2)} - \mu_n^2. \]

where

\[ \mu_n = \frac{1}{n} \sum_{i = 1}^n x_i. \]

is the estimate of the sample mean and $n$ is the number of samples.

Member Typedef Documentation

typedef mpl::false_ boost::accumulators::accumulator_base::is_droppable
inherited
template<typename Sample , typename MeanFeature >
typedef numeric::functional::fdiv<Sample, std::size_t>::result_type boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature >::result_type

Constructor & Destructor Documentation

template<typename Sample , typename MeanFeature >
boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature >::lazy_variance_impl ( dont_care  )
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
detail::void_ boost::accumulators::accumulator_base::operator() ( dont_care  )
inlineinherited
template<typename Sample , typename MeanFeature >
template<typename Args >
result_type boost::accumulators::impl::lazy_variance_impl< Sample, MeanFeature >::result ( Args const &  args) const
inline

References boost::python::args(), and boost::accumulators::extract::mean.

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