boost::accumulators::impl::weighted_density_impl< Sample, Weight > Struct Template Reference

Histogram density estimator for weighted samples. More...

#include <statistics_fwd.hpp>

Inheritance diagram for boost::accumulators::impl::weighted_density_impl< Sample, Weight >:

Collaboration diagram for boost::accumulators::impl::weighted_density_impl< Sample, Weight >:

Public Types
typedef numeric::functional::fdiv < Weight, 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 >
	weighted_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, typename Weight>
struct boost::accumulators::impl::weighted_density_impl< Sample, Weight >

Histogram density estimator for weighted samples.

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 returned, where each pair contains the position of the bin (lower bound) and the sum of the weights (normalized with the sum of all weights).

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).

Member Typedef Documentation

template<typename Sample , typename Weight >

typedef std::vector<float_type> boost::accumulators::impl::weighted_density_impl< Sample, Weight >::array_type

template<typename Sample , typename Weight >

typedef numeric::functional::fdiv<Weight, std::size_t>::result_type boost::accumulators::impl::weighted_density_impl< Sample, Weight >::float_type

template<typename Sample , typename Weight >

typedef std::vector<std::pair<float_type, float_type> > boost::accumulators::impl::weighted_density_impl< Sample, Weight >::histogram_type

typedef mpl::false_ boost::accumulators::accumulator_base::is_droppable

inherited

template<typename Sample , typename Weight >

typedef iterator_range<typename histogram_type::iterator> boost::accumulators::impl::weighted_density_impl< Sample, Weight >::result_type

Constructor & Destructor Documentation

template<typename Sample , typename Weight >

template<typename Args >

boost::accumulators::impl::weighted_density_impl< Sample, Weight >::weighted_density_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

detail::void_ boost::accumulators::accumulator_base::operator() ( dont_care  )

inlineinherited

template<typename Sample , typename Weight >

template<typename Args >

void boost::accumulators::impl::weighted_density_impl< Sample, Weight >::operator() ( Args const &  args )

inline

References count, boost::fusion::distance(), boost::multiprecision::backends::i, boost::it, boost::xpressive::make_pair, boost::accumulators::extract::max, boost::accumulators::extract::min, boost::multiprecision::backends::this, and boost::numeric::ublas::detail::upper_bound().

template<typename Sample , typename Weight >

template<typename Args >

result_type boost::accumulators::impl::weighted_density_impl< Sample, Weight >::result ( Args const &  args ) const

inline

References boost::multiprecision::backends::i, boost::make_iterator_range(), boost::xpressive::make_pair, and boost::accumulators::extract::sum_of_weights.

---

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

• boost_1_57_0/boost/accumulators/statistics/weighted_density.hpp