Rosetta 3.3
Public Member Functions
numeric::MultiDimensionalHistogram Class Reference

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

#include <MultiDimensionalHistogram.hh>

Collaboration diagram for numeric::MultiDimensionalHistogram:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MultiDimensionalHistogram ()
 Constructor.
 MultiDimensionalHistogram (numeric::Size num_dims)
 ~MultiDimensionalHistogram ()
 Destructor.
 MultiDimensionalHistogram (MultiDimensionalHistogram const &mdhist)
 Copy constructor.
MultiDimensionalHistogramoperator= (MultiDimensionalHistogram const &rhs)
 operator=
numeric::Size num_dimensions () const
void num_dimensions (numeric::Size num)
utility::vector1< numeric::Sizenum_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::Realstart () const
void start (utility::vector1< numeric::Real > const &start1)
void start (numeric::Size dim, numeric::Real start)
utility::vector1< numeric::Realend () 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)

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

MultiDimensionalHistogram numeric::MultiDimensionalHistogram::collapse ( utility::vector1< numeric::Size dimensions) const [inline]
utility::vector0<numeric::Size> const& numeric::MultiDimensionalHistogram::counts ( ) const [inline]

Referenced by numeric::operator<<().

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

References color_pdb::i, and num_dimensions().

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

References color_pdb::i.

Referenced by numeric::operator<<().

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

References color_pdb::i.

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

void numeric::MultiDimensionalHistogram::end ( numeric::Real  end) [inline]

References end(), color_pdb::i, and num_dimensions().

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

References color_pdb::i, and num_dimensions().

void numeric::MultiDimensionalHistogram::end ( numeric::Size  dim,
numeric::Real  end 
) [inline]

References end(), and num_dimensions().

void numeric::MultiDimensionalHistogram::label ( std::string const &  label) [inline]

References label().

std::string const& numeric::MultiDimensionalHistogram::label ( ) const [inline]
numeric::Real numeric::MultiDimensionalHistogram::mean_squared_error ( utility::vector1< utility::vector1< numeric::Real > > const &  expected_1d_frequencies) [inline]
void numeric::MultiDimensionalHistogram::num_bins ( numeric::Size  num_bins) [inline]

References color_pdb::i, and num_bins().

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

References color_pdb::i, and num_dimensions().

utility::vector1<numeric::Size> numeric::MultiDimensionalHistogram::num_bins ( ) const [inline]
void numeric::MultiDimensionalHistogram::num_bins ( numeric::Size  dim,
numeric::Size  num_bins 
) [inline]

References num_bins(), and num_dimensions().

numeric::Size numeric::MultiDimensionalHistogram::num_dimensions ( ) const [inline]
void numeric::MultiDimensionalHistogram::num_dimensions ( numeric::Size  num) [inline]

References num_bins().

MultiDimensionalHistogram& numeric::MultiDimensionalHistogram::operator= ( MultiDimensionalHistogram const &  rhs) [inline]

operator=

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

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

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

References num_dimensions().

void numeric::MultiDimensionalHistogram::record ( numeric::Real  value) [inline]

References num_dimensions().

void numeric::MultiDimensionalHistogram::reset_counts ( ) [inline]

References color_pdb::i.

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

References num_dimensions(), and start().

void numeric::MultiDimensionalHistogram::start ( numeric::Real  start) [inline]

References color_pdb::i, num_dimensions(), and start().

Referenced by numeric::operator<<().

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

References color_pdb::i.

Referenced by range(), set_dimension(), and start().

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

References color_pdb::i, and num_dimensions().

numeric::Size numeric::MultiDimensionalHistogram::total_counts ( ) const [inline]

Referenced by mean_squared_error().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines