jb::integer_range_binning< sample_type_t > Class Template Reference

A histogram binning_strategy for integer numbers in a known range. More...

#include <integer_range_binning.hpp>

Public Types
typedef sample_type_t	sample_type
	type traits as required by jb::binning_strategy_concept More...

Public Member Functions
	integer_range_binning (sample_type h_min, sample_type h_max)
	Constructor based on the histogram range. More...
Implement binning_strategy_concept interface.
Please see binning_strategy_concept for detailed documentation of each member function.
sample_type	histogram_min () const
sample_type	histogram_max () const
sample_type	theoretical_min () const
sample_type	theoretical_max () const
std::size_t	sample2bin (sample_type t) const
sample_type	bin2sample (std::size_t i) const
sample_type	interpolate (sample_type x_a, sample_type x_b, double y_a, double s, double q) const

Private Attributes
sample_type	h_min_
sample_type	h_max_

Detailed Description

template<typename sample_type_t>
class jb::integer_range_binning< sample_type_t >

A histogram binning_strategy for integer numbers in a known range.

This class defines histogram bins for samples with integer values in a range defined at run-time. Care must be taken if the range is too big because the corresponding histogram is likely to consume a lot of memory. See jb::binning_strategy_concept.

Template Parameters

sample_type_t

the type of samples, should be an integer type.

Definition at line 24 of file integer_range_binning.hpp.

Member Typedef Documentation

sample_type

template<typename sample_type_t>

typedef sample_type_t jb::integer_range_binning< sample_type_t >::sample_type

type traits as required by jb::binning_strategy_concept

Definition at line 27 of file integer_range_binning.hpp.

Constructor & Destructor Documentation

integer_range_binning()

template<typename sample_type_t>

jb::integer_range_binning< sample_type_t >::integer_range_binning ( sample_type  h_min, sample_type  h_max  )

inline

Constructor based on the histogram range.

Parameters

h_min	The value for histogram_min()
h_max	The value for histogram_max()

Definition at line 35 of file integer_range_binning.hpp.

Member Function Documentation

bin2sample()

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::bin2sample ( std::size_t  i ) const

inline

Definition at line 71 of file integer_range_binning.hpp.

histogram_max()

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::histogram_max ( ) const

inline

Definition at line 59 of file integer_range_binning.hpp.

histogram_min()

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::histogram_min ( ) const

inline

Definition at line 56 of file integer_range_binning.hpp.

Referenced by jb::integer_range_binning< std::int64_t >::bin2sample(), and jb::integer_range_binning< std::int64_t >::sample2bin().

interpolate()

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::interpolate ( sample_type  x_a, sample_type  x_b, double  y_a, double  s, double  q  ) const

inline

Definition at line 74 of file integer_range_binning.hpp.

sample2bin()

template<typename sample_type_t>

std::size_t jb::integer_range_binning< sample_type_t >::sample2bin ( sample_type  t ) const

inline

Definition at line 68 of file integer_range_binning.hpp.

theoretical_max()

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::theoretical_max ( ) const

inline

Definition at line 65 of file integer_range_binning.hpp.

theoretical_min()

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::theoretical_min ( ) const

inline

Definition at line 62 of file integer_range_binning.hpp.

Member Data Documentation

h_max_

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::h_max_

private

Definition at line 82 of file integer_range_binning.hpp.

Referenced by jb::integer_range_binning< std::int64_t >::histogram_max(), and jb::integer_range_binning< std::int64_t >::integer_range_binning().

h_min_

template<typename sample_type_t>

sample_type jb::integer_range_binning< sample_type_t >::h_min_

private

Definition at line 81 of file integer_range_binning.hpp.

Referenced by jb::integer_range_binning< std::int64_t >::histogram_min(), and jb::integer_range_binning< std::int64_t >::integer_range_binning().

---

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

• jb/integer_range_binning.hpp