numeric::MultiDimensionalHistogram Class Reference

a class for accumulating a histogram of one or more numeric variables More...

#include <MultiDimensionalHistogram.hh>

Public Member Functions
	MultiDimensionalHistogram ()
	Constructor. More...
	MultiDimensionalHistogram (numeric::Size num_dims)
	~MultiDimensionalHistogram ()
	Destructor. More...
	MultiDimensionalHistogram (MultiDimensionalHistogram const &mdhist)
	Copy constructor. More...
MultiDimensionalHistogram &	operator= (MultiDimensionalHistogram const &rhs)
	operator= More...
numeric::Size	num_dimensions () const
void	num_dimensions (numeric::Size num)
utility::vector1< numeric::Size >	num_bins () const
void	num_bins (numeric::Size num_bins)
void	num_bins (utility::vector1< numeric::Size > const &num_bins1)
void	num_bins (numeric::Size dim, numeric::Size num_bins)
void	start (numeric::Real start)
utility::vector1< numeric::Real >	start () const
void	start (utility::vector1< numeric::Real > const &start1)
void	start (numeric::Size dim, numeric::Real start)
utility::vector1< numeric::Real >	end () const
void	end (numeric::Real end)
void	end (utility::vector1< numeric::Real > const &end1)
void	end (numeric::Size dim, numeric::Real end)
void	range (numeric::Size dim, numeric::Real start, numeric::Real end)
void	set_dimension (numeric::Size dim, numeric::Size num_bins, numeric::Real start, numeric::Real end, std::string label="")
std::string const &	label () const
void	label (std::string const &label)
utility::vector1< std::string >	dim_labels () const
void	dim_labels (utility::vector1< std::string > const &dim_labels1)
void	reset_counts ()
void	record (utility::vector1< numeric::Real > const &values)
void	record (numeric::Real value)
utility::vector0 < numeric::Size > const &	counts () const
numeric::Size	total_counts () const
MultiDimensionalHistogram	collapse (utility::vector1< numeric::Size > dimensions) const
numeric::Real	mean_squared_error (utility::vector1< utility::vector1< numeric::Real > > const &expected_1d_frequencies)

Private Member Functions
void	resize_counts ()
numeric::Size	bin_index (numeric::Size dim, numeric::Real value) const
numeric::Size	bin_index (utility::vector1< numeric::Real > const &values) const
numeric::Size	bin_index (utility::vector0< numeric::Size > const &indices) const

Private Attributes
utility::vector0< numeric::Size >	num_bins_
utility::vector0< numeric::Real >	start_
utility::vector0< numeric::Real >	end_
std::string	label_
utility::vector0< std::string >	dim_labels_
numeric::Size	total_counts_
utility::vector0< numeric::Size >	counts_

Detailed Description

a class for accumulating a histogram of one or more numeric variables

Constructor & Destructor Documentation

numeric::MultiDimensionalHistogram::MultiDimensionalHistogram ( )

inline

Constructor.

References num_dimensions().

numeric::MultiDimensionalHistogram::MultiDimensionalHistogram ( numeric::Size  num_dims )

inline

References num_dimensions().

numeric::MultiDimensionalHistogram::~MultiDimensionalHistogram ( )

inline

Destructor.

numeric::MultiDimensionalHistogram::MultiDimensionalHistogram ( MultiDimensionalHistogram const &  mdhist )

inline

Copy constructor.

Member Function Documentation

numeric::Size numeric::MultiDimensionalHistogram::bin_index ( numeric::Size  dim, numeric::Real  value  ) const

inlineprivate

References end_, ObjexxFCL::index(), num_bins_, and start_.

Referenced by bin_index(), collapse(), mean_squared_error(), and record().

numeric::Size numeric::MultiDimensionalHistogram::bin_index ( utility::vector1< numeric::Real > const &  values ) const

inlineprivate

References bin_index(), counts_, ObjexxFCL::index(), basic::options::OptionKeys::ms::checkpoint::interval, num_bins_, and num_dimensions().

numeric::Size numeric::MultiDimensionalHistogram::bin_index ( utility::vector0< numeric::Size > const &  indices ) const

inlineprivate

References ObjexxFCL::index(), basic::options::OptionKeys::ms::checkpoint::interval, num_bins_, and num_dimensions().

MultiDimensionalHistogram numeric::MultiDimensionalHistogram::collapse ( utility::vector1< numeric::Size >  dimensions ) const

inline

References bin_index(), counts_, dim_labels_, end_, label_, num_bins_, num_dimensions(), resize_counts(), runtime_assert, start_, and total_counts_.

utility::vector0<numeric::Size> const& numeric::MultiDimensionalHistogram::counts ( ) const

inline

References counts_.

Referenced by numeric::operator<<().

utility::vector1<std::string> numeric::MultiDimensionalHistogram::dim_labels ( ) const

inline

References dim_labels_.

Referenced by numeric::operator<<().

void numeric::MultiDimensionalHistogram::dim_labels ( utility::vector1< std::string > const &  dim_labels1 )

inline

References dim_labels_, and num_dimensions().

utility::vector1<numeric::Real> numeric::MultiDimensionalHistogram::end ( ) const

inline

References end_.

Referenced by end(), numeric::operator<<(), range(), and set_dimension().

void numeric::MultiDimensionalHistogram::end ( numeric::Real  end )

inline

References end(), end_, and num_dimensions().

void numeric::MultiDimensionalHistogram::end ( utility::vector1< numeric::Real > const &  end1 )

inline

References end_, and num_dimensions().

void numeric::MultiDimensionalHistogram::end ( numeric::Size  dim, numeric::Real  end  )

inline

References end(), end_, and num_dimensions().

std::string const& numeric::MultiDimensionalHistogram::label ( ) const

inline

References label_.

Referenced by label(), numeric::operator<<(), and set_dimension().

void numeric::MultiDimensionalHistogram::label ( std::string const &  label )

inline

References label(), and label_.

numeric::Real numeric::MultiDimensionalHistogram::mean_squared_error ( utility::vector1< utility::vector1< numeric::Real > > const &  expected_1d_frequencies )

inline

References bin_index(), counts_, amino_acids::frequency, num_bins(), num_bins_, num_dimensions(), runtime_assert, amino_acids::size, total_counts(), and total_counts_.

utility::vector1<numeric::Size> numeric::MultiDimensionalHistogram::num_bins ( ) const

inline

References num_bins_.

Referenced by mean_squared_error(), num_bins(), num_dimensions(), numeric::operator<<(), and set_dimension().

void numeric::MultiDimensionalHistogram::num_bins ( numeric::Size  num_bins )

inline

References num_bins(), num_bins_, and resize_counts().

void numeric::MultiDimensionalHistogram::num_bins ( utility::vector1< numeric::Size > const &  num_bins1 )

inline

References num_bins_, num_dimensions(), and resize_counts().

void numeric::MultiDimensionalHistogram::num_bins ( numeric::Size  dim, numeric::Size  num_bins  )

inline

References num_bins(), num_bins_, num_dimensions(), and resize_counts().

numeric::Size numeric::MultiDimensionalHistogram::num_dimensions ( ) const

inline

References num_bins_.

Referenced by bin_index(), collapse(), dim_labels(), end(), mean_squared_error(), MultiDimensionalHistogram(), num_bins(), numeric::operator<<(), range(), record(), resize_counts(), set_dimension(), and start().

void numeric::MultiDimensionalHistogram::num_dimensions ( numeric::Size  num )

inline

References dim_labels_, end_, num_bins(), num_bins_, and start_.

MultiDimensionalHistogram& numeric::MultiDimensionalHistogram::operator= ( MultiDimensionalHistogram const &  rhs )

inline

operator=

References counts_, dim_labels_, end_, label_, num_bins_, start_, and total_counts_.

void numeric::MultiDimensionalHistogram::range ( numeric::Size  dim, numeric::Real  start, numeric::Real  end  )

inline

References end(), end_, num_dimensions(), start(), and start_.

void numeric::MultiDimensionalHistogram::record ( utility::vector1< numeric::Real > const &  values )

inline

References bin_index(), counts_, num_dimensions(), and total_counts_.

void numeric::MultiDimensionalHistogram::record ( numeric::Real  value )

inline

References bin_index(), counts_, num_dimensions(), and total_counts_.

void numeric::MultiDimensionalHistogram::reset_counts ( )

inline

References counts_, and total_counts_.

void numeric::MultiDimensionalHistogram::resize_counts ( )

inlineprivate

References counts_, num_bins_, and num_dimensions().

Referenced by collapse(), num_bins(), and set_dimension().

void numeric::MultiDimensionalHistogram::set_dimension ( numeric::Size  dim, numeric::Size  num_bins, numeric::Real  start, numeric::Real  end, std::string  label = ""  )

inline

References dim_labels_, end(), end_, label(), num_bins(), num_bins_, num_dimensions(), resize_counts(), start(), and start_.

void numeric::MultiDimensionalHistogram::start ( numeric::Real  start )

inline

References num_dimensions(), start(), and start_.

Referenced by pyrosetta.tests.distributed.test_gil.HeartBeat::__enter__(), and numeric::operator<<().

utility::vector1<numeric::Real> numeric::MultiDimensionalHistogram::start ( ) const

inline

References start_.

Referenced by pyrosetta.tests.distributed.test_gil.HeartBeat::__enter__(), range(), set_dimension(), and start().

void numeric::MultiDimensionalHistogram::start ( utility::vector1< numeric::Real > const &  start1 )

inline

References num_dimensions(), and start_.

Referenced by pyrosetta.tests.distributed.test_gil.HeartBeat::__enter__().

void numeric::MultiDimensionalHistogram::start ( numeric::Size  dim, numeric::Real  start  )

inline

References num_dimensions(), start(), and start_.

Referenced by pyrosetta.tests.distributed.test_gil.HeartBeat::__enter__().

numeric::Size numeric::MultiDimensionalHistogram::total_counts ( ) const

inline

References total_counts_.

Referenced by mean_squared_error().

Member Data Documentation

utility::vector0<numeric::Size> numeric::MultiDimensionalHistogram::counts_

private

Referenced by bin_index(), collapse(), counts(), mean_squared_error(), operator=(), record(), reset_counts(), and resize_counts().

utility::vector0<std::string> numeric::MultiDimensionalHistogram::dim_labels_

private

Referenced by collapse(), dim_labels(), num_dimensions(), operator=(), and set_dimension().

utility::vector0<numeric::Real> numeric::MultiDimensionalHistogram::end_

private

Referenced by bin_index(), collapse(), end(), num_dimensions(), operator=(), range(), and set_dimension().

std::string numeric::MultiDimensionalHistogram::label_

private

Referenced by collapse(), label(), and operator=().

utility::vector0<numeric::Size> numeric::MultiDimensionalHistogram::num_bins_

private

Referenced by bin_index(), collapse(), mean_squared_error(), num_bins(), num_dimensions(), operator=(), resize_counts(), and set_dimension().

utility::vector0<numeric::Real> numeric::MultiDimensionalHistogram::start_

private

Referenced by bin_index(), collapse(), num_dimensions(), operator=(), range(), set_dimension(), and start().

numeric::Size numeric::MultiDimensionalHistogram::total_counts_

private

Referenced by collapse(), mean_squared_error(), operator=(), record(), reset_counts(), and total_counts().

---

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

• src/numeric/MultiDimensionalHistogram.hh