Detailed Description

template<typename T>
class BaseLib::Histogram< T >

Basic Histogram implementation.

Creates histogram from input data of type T.

Definition at line 32 of file Histogram.h.

#include <Histogram.h>

Public Types
using	Data = typename std::vector< double >

Public Member Functions
template<typename InputIterator >
	Histogram (InputIterator first, InputIterator last, const int nr_bins=16, const bool computeHistogram=true)
	Underlying input data vector type. More...

	Histogram (std::vector< T > data, const unsigned int nr_bins=16, const bool computeHistogram=true)

void	update ()

void	setMinimum (const T &minimum)

void	setMaximum (const T &maximum)

const Data &	getSortedData () const

const std::vector< std::size_t > &	getBinCounts () const

const unsigned int &	getNumberOfBins () const

const T &	getMinimum () const

const T &	getMaximum () const

const T &	getBinWidth () const

void	prettyPrint (std::ostream &os, const unsigned int line_width=16) const

int	write (std::string const &file_name, std::string const &data_set_name, std::string const &param_name) const

Protected Member Functions
void	init (const bool computeHistogram=true)

Protected Attributes
Data	data_

const unsigned int	nr_bins_

std::vector< std::size_t >	histogram_

T	min_

T	max_
	Minimum and maximum input data values. More...

T	bin_width_

Private Attributes
bool	dirty_
	When set `update()` will recompute histogram. More...

Member Typedef Documentation

◆ Data

template<typename T >

using BaseLib::Histogram< T >::Data = typename std::vector<double>

Definition at line 35 of file Histogram.h.

Constructor & Destructor Documentation

◆ Histogram() [1/2]

template<typename T >

template<typename InputIterator >

BaseLib::Histogram< T >::Histogram	(	InputIterator	first,
		InputIterator	last,
		const int	nr_bins = `16`,
		const bool	computeHistogram = `true`
	)

inline

Underlying input data vector type.

Creates histogram of the given element in the range [first, last).

Input data is copied into std::vector.

Parameters

first	Range of elements to create histogram from.
last	Range of elements to create histogram from.
nr_bins	Number of bins in histogram.
computeHistogram	Compute histogram if set. If not set user must call `update()` before accessing data.

Definition at line 50 of file Histogram.h.

         : data_(first, last), nr_bins_(nr_bins), dirty_(true)
     {
         init(computeHistogram);
     }

References BaseLib::Histogram< T >::init().

◆ Histogram() [2/2]

template<typename T >

BaseLib::Histogram< T >::Histogram	(	std::vector< T >	data,
		const unsigned int	nr_bins = `16`,
		const bool	computeHistogram = `true`
	)

inlineexplicit

Creates histogram from std::vector.

Parameters

data	Input vector.
nr_bins	Number of bins in histogram.
computeHistogram	Compute histogram if set. If not set user must call `update()` before accessing data.

Definition at line 63 of file Histogram.h.

         : data_(std::move(data)), nr_bins_(nr_bins), dirty_(true)
     {
         init(computeHistogram);
     }

References BaseLib::Histogram< T >::init().

Member Function Documentation

◆ getBinCounts()

template<typename T >

const std::vector<std::size_t>& BaseLib::Histogram< T >::getBinCounts ( ) const

inline

Definition at line 112 of file Histogram.h.

112 { return histogram_; }

BaseLib::Histogram::histogram_

std::vector< std::size_t > histogram_

Definition: Histogram.h:189

References BaseLib::Histogram< T >::histogram_.

Referenced by BaseLib::operator<<(), and BaseLib::Histogram< T >::write().

◆ getBinWidth()

template<typename T >

const T& BaseLib::Histogram< T >::getBinWidth ( ) const

inline

Definition at line 116 of file Histogram.h.

116 { return bin_width_; }

BaseLib::Histogram::bin_width_

T bin_width_

Definition: Histogram.h:191

References BaseLib::Histogram< T >::bin_width_.

Referenced by BaseLib::Histogram< T >::write().

◆ getMaximum()

template<typename T >

const T& BaseLib::Histogram< T >::getMaximum ( ) const

inline

Definition at line 115 of file Histogram.h.

115 { return max_; }

BaseLib::Histogram::max_

T max_

Minimum and maximum input data values.

Definition: Histogram.h:190

References BaseLib::Histogram< T >::max_.

Referenced by BaseLib::operator<<().

◆ getMinimum()

template<typename T >

const T& BaseLib::Histogram< T >::getMinimum ( ) const

inline

Definition at line 114 of file Histogram.h.

114 { return min_; }

BaseLib::Histogram::min_

T min_

Definition: Histogram.h:190

References BaseLib::Histogram< T >::min_.

Referenced by BaseLib::operator<<(), and BaseLib::Histogram< T >::write().

◆ getNumberOfBins()

template<typename T >

const unsigned int& BaseLib::Histogram< T >::getNumberOfBins ( ) const

inline

Definition at line 113 of file Histogram.h.

113 { return nr_bins_; }

References BaseLib::Histogram< T >::nr_bins_.

Referenced by BaseLib::operator<<(), and BaseLib::Histogram< T >::write().

◆ getSortedData()

template<typename T >

const Data& BaseLib::Histogram< T >::getSortedData ( ) const

inline

Definition at line 111 of file Histogram.h.

111 { return data_; }

References BaseLib::Histogram< T >::data_.

◆ init()

template<typename T >

void BaseLib::Histogram< T >::init ( const bool computeHistogram = true )

inlineprotected

Initialize class members after constructor call.

Definition at line 172 of file Histogram.h.

     {
         std::sort(data_.begin(), data_.end());
         histogram_.resize(nr_bins_);
         min_ = data_.front();
         max_ = data_.back();
         bin_width_ = (max_ - min_) / nr_bins_;
  
         dirty_ = true;
         if (computeHistogram)
         {
             update();
         }
     }

References BaseLib::Histogram< T >::bin_width_, BaseLib::Histogram< T >::data_, BaseLib::Histogram< T >::dirty_, BaseLib::Histogram< T >::histogram_, BaseLib::Histogram< T >::max_, BaseLib::Histogram< T >::min_, BaseLib::Histogram< T >::nr_bins_, and BaseLib::Histogram< T >::update().

Referenced by BaseLib::Histogram< T >::Histogram().

◆ prettyPrint()

template<typename T >

void BaseLib::Histogram< T >::prettyPrint	(	std::ostream &	os,
		const unsigned int	line_width = `16`
	)		const

inline

Definition at line 118 of file Histogram.h.

     {
         const std::size_t count_max =
             *std::max_element(histogram_.begin(), histogram_.end());
         for (unsigned int bin = 0; bin < nr_bins_; ++bin)
         {
             os << "[" << min_ + bin * bin_width_ << ", "
                << min_ + (bin + 1) * bin_width_ << ")\t";
             os << histogram_[bin] << "\t";
  
             const int n_stars =
                 std::ceil(line_width * ((double)histogram_[bin] / count_max));
             for (int star = 0; star < n_stars; star++)
             {
                 os << "*";
             }
             os << "\n";
         }
     }

References BaseLib::Histogram< T >::bin_width_, BaseLib::Histogram< T >::histogram_, BaseLib::Histogram< T >::min_, and BaseLib::Histogram< T >::nr_bins_.

◆ setMaximum()

template<typename T >

void BaseLib::Histogram< T >::setMaximum ( const T & maximum )

inline

Definition at line 105 of file Histogram.h.

     {
         max_ = maximum;
         dirty_ = true;
     }

References BaseLib::Histogram< T >::dirty_, and BaseLib::Histogram< T >::max_.

◆ setMinimum()

template<typename T >

void BaseLib::Histogram< T >::setMinimum ( const T & minimum )

inline

Definition at line 100 of file Histogram.h.

     {
         min_ = minimum;
         dirty_ = true;
     }

References BaseLib::Histogram< T >::dirty_, and BaseLib::Histogram< T >::min_.

◆ update()

template<typename T >

void BaseLib::Histogram< T >::update ( )

inline

Updates histogram using sorted data_ vector.

Start histogram creation with first element. Then find first element in the next histogram bin. Number of elements in the bin is the difference between these two iterators.

[0.1, 0.2, ..., 0.7 , ..., 0.7+binWidth = 0.9,  1.0  , ..., last]
                it             itEnd - 1      itEnd

Definition at line 80 of file Histogram.h.

     {
         if (!dirty_)
         {
             return;
         }
  
         bin_width_ = (max_ - min_) / nr_bins_;
  
         auto it = data_.begin();
         for (unsigned int bin = 0; bin < nr_bins_; bin++)
         {
             auto itEnd = std::upper_bound(it, data_.end(),
                                           min_ + (bin + 1) * bin_width_);
             histogram_[bin] = std::distance(it, itEnd);
             it = itEnd;
         }
         dirty_ = false;
     }

References BaseLib::Histogram< T >::bin_width_, BaseLib::Histogram< T >::data_, BaseLib::Histogram< T >::dirty_, BaseLib::Histogram< T >::histogram_, BaseLib::Histogram< T >::max_, BaseLib::Histogram< T >::min_, and BaseLib::Histogram< T >::nr_bins_.

Referenced by BaseLib::Histogram< T >::init().

◆ write()

template<typename T >

int BaseLib::Histogram< T >::write	(	std::string const &	file_name,
		std::string const &	data_set_name,
		std::string const &	param_name
	)		const

inline

Definition at line 138 of file Histogram.h.

     {
         if (file_name.empty())
         {
             ERR("No file name specified.");
             return 1;
         }
  
         std::ofstream out(file_name);
         if (!out)
         {
             ERR("Error writing histogram: Could not open file.");
             return 1;
         }
  
         out << "# Histogram for parameter " << param_name << " of data set "
             << data_set_name << "\n";
         std::size_t const n_bins = this->getNumberOfBins();
         std::vector<std::size_t> const& bin_cnts(this->getBinCounts());
         double const min(this->getMinimum());
         double const bin_width(this->getBinWidth());
  
         for (std::size_t k(0); k < n_bins; k++)
         {
             out << min + k * bin_width << " " << bin_cnts[k] << "\n";
         }
         out.close();
         return 0;
     }