Histogram density estimator. More...

#include <statistics_fwd.hpp>

Inheritance diagram for boost::accumulators::impl::density_impl< Sample >:

Collaboration diagram for boost::accumulators::impl::density_impl< Sample >:

Public Types
typedef numeric::functional::fdiv < Sample, std::size_t > ::result_type	float_type

typedef std::vector< std::pair < float_type, float_type > >	histogram_type

typedef std::vector< float_type >	array_type

typedef iterator_range < typename histogram_type::iterator >	result_type

typedef mpl::false_	is_droppable

Public Member Functions
template<typename Args >
	density_impl (Args const &args)

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

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>
struct boost::accumulators::impl::density_impl< Sample >

Histogram density estimator.

The histogram density estimator returns a histogram of the sample distribution. The positions and sizes of the bins are determined using a specifiable number of cached samples (cache_size). The range between the minimum and the maximum of the cached samples is subdivided into a specifiable number of bins (num_bins) of same size. Additionally, an under- and an overflow bin is added to capture future under- and overflow samples. Once the bins are determined, the cached samples and all subsequent samples are added to the correct bins. At the end, a range of std::pair is return, where each pair contains the position of the bin (lower bound) and the samples count (normalized with the total number of samples).

Parameters

density_cache_size	Number of first samples used to determine min and max.
density_num_bins	Number of bins (two additional bins collect under- and overflow samples).