HistogramHelper< Scalar, EnableIf > Class Template Reference

Public Member Functions

 HistogramHelper (int nbins)
 
 HistogramHelper (Scalar lower, Scalar upper, int nbins)
 
int bin (Scalar v)
 
double uniform_bin_probability (int bin)
 

Private Attributes

double lower_
 
double upper_
 
int num_bins_
 
double bin_width_
 

Constructor & Destructor Documentation

◆ HistogramHelper() [1/2]

template<typename Scalar , typename EnableIf = void>
HistogramHelper< Scalar, EnableIf >::HistogramHelper ( int  nbins)
inline
59 : HistogramHelper(Scalar(-1), Scalar(1), nbins) {}
SCALAR Scalar
Definition: bench_gemm.cpp:45
HistogramHelper(int nbins)
Definition: rand.cpp:59

◆ HistogramHelper() [2/2]

template<typename Scalar , typename EnableIf = void>
HistogramHelper< Scalar, EnableIf >::HistogramHelper ( Scalar  lower,
Scalar  upper,
int  nbins 
)
inline
60  {
61  lower_ = static_cast<double>(lower);
62  upper_ = static_cast<double>(upper);
63  num_bins_ = nbins;
64  bin_width_ = (upper_ - lower_) / static_cast<double>(nbins);
65  }
double lower_
Definition: rand.cpp:80
double upper_
Definition: rand.cpp:81
int num_bins_
Definition: rand.cpp:82
double bin_width_
Definition: rand.cpp:83
std::string lower(std::string s)
returns the input string after converting upper-case characters to lower case
Definition: StringHelpers.cc:11

References HistogramHelper< Scalar, EnableIf >::bin_width_, helpers::lower(), HistogramHelper< Scalar, EnableIf >::lower_, HistogramHelper< Scalar, EnableIf >::num_bins_, and HistogramHelper< Scalar, EnableIf >::upper_.

Member Function Documentation

◆ bin()

template<typename Scalar , typename EnableIf = void>
int HistogramHelper< Scalar, EnableIf >::bin ( Scalar  v)
inline
66  {
67  double result = (static_cast<double>(v) - lower_) / bin_width_;
68  return std::min<int>(static_cast<int>(result), num_bins_ - 1);
69  }
Array< int, Dynamic, 1 > v
Definition: Array_initializer_list_vector_cxx11.cpp:1

References HistogramHelper< Scalar, EnableIf >::bin_width_, HistogramHelper< Scalar, EnableIf >::lower_, HistogramHelper< Scalar, EnableIf >::num_bins_, and v.

Referenced by check_histogram(), HistogramHelper< Scalar, EnableIf >::uniform_bin_probability(), and HistogramHelper< Scalar, std::enable_if_t< Eigen::NumTraits< Scalar >::IsInteger > >::uniform_bin_probability().

◆ uniform_bin_probability()

template<typename Scalar , typename EnableIf = void>
double HistogramHelper< Scalar, EnableIf >::uniform_bin_probability ( int  bin)
inline
71  {
72  double range = upper_ - lower_;
73  if (bin < num_bins_ - 1) {
74  return bin_width_ / range;
75  }
76  return (upper_ - (lower_ + double(bin) * bin_width_)) / range;
77  }
int bin(Scalar v)
Definition: rand.cpp:66

References HistogramHelper< Scalar, EnableIf >::bin(), HistogramHelper< Scalar, EnableIf >::bin_width_, HistogramHelper< Scalar, EnableIf >::lower_, HistogramHelper< Scalar, EnableIf >::num_bins_, and HistogramHelper< Scalar, EnableIf >::upper_.

Referenced by check_histogram().

Member Data Documentation

◆ bin_width_

◆ lower_

◆ num_bins_

◆ upper_


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