IMP  2.1.0
The Integrative Modeling Platform
IMP::statistics::Histogram Class Reference

Histogram. More...

#include <IMP/statistics/Histogram.h>

Public Member Functions

 Histogram (double start, double end, unsigned int num_bins)
 Constructor. More...
 
void add (double x)
 Increase the count for the bin that holds a.
 
double get_top (double percentage) const
 Get the lowest value for which X% of the histogram data is lower from. More...
 
unsigned int get_total_count () const
 Get the sum of all counts in the histogram.
 
void show (std::ostream &out=std::cout) const
 

Detailed Description

Keeps a set of values within a range the range is arranged into some number of bins specified during construction.

Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use HistogramD instead.

Definition at line 26 of file Histogram.h.

Constructor & Destructor Documentation

IMP::statistics::Histogram::Histogram ( double  start,
double  end,
unsigned int  num_bins 
)
Parameters
[in]startthe start value of the range
[in]endthe end value of the range
[in]num_binsthe number of bins [start,end] is divided to

Member Function Documentation

double IMP::statistics::Histogram::get_top ( double  percentage) const
Parameters
percentagethe percenrage (between 0 to 1) The name of this function will change to be more accurate.
Warning: get_top has not been stabilized and is likely to change without notice.

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