Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

Histo::OneDBinList Class Reference

Abstract base class for Histogram-like objects consisting of a finite one-dimensional list of bins with counts and values (possibly identical) in each bin, plus total counts and values. More...

#include <histogram.h>

Inheritance diagram for Histo::OneDBinList

Inheritance graph

[legend]
List of all members.

Public Types

typedef vector<Value>::size_type size_type

Public Methods

 OneDBinList (const int num_bins)
OneDBinList& add (size_type bin, Value val=1)
 Add the specified value to the histogram bin specified. More...

Summary access functions
Report statistics about the whole histogram.

size_type num_bins () const
Value total_value () const
 Not merely the sum of the current values, if histogram is a difference. More...

Count total_count () const
 Not merely the count of the current values, if histogram is a difference. More...

Value max_value () const
Value min_value () const
Count max_count () const
Count min_count () const
Element access functions
Return the value of a single bin in the histogram.

Value value (size_type i) const
Count count (size_type i) const
double value_percent (size_type i) const
double count_percent (size_type i) const

Protected Attributes

vector<Count> counts
vector<Value> values
Count total_c
Value total_v

Friends

class  operator-

Detailed Description

Abstract base class for Histogram-like objects consisting of a finite one-dimensional list of bins with counts and values (possibly identical) in each bin, plus total counts and values.

This class is designed to include some classes which are not, strictly speaking, histograms, e.g. if their total counts are less than the sum of the individual counts, or if individual counts are less than zero.

Definition at line 26 of file histogram.h.


Member Typedef Documentation

template<classCount = int, classValue = double>
typedef vector<Value>::size_type Histo::OneDBinList<Count, Value>::size_type
 

Definition at line 37 of file histogram.h.


Constructor & Destructor Documentation

template<classCount = int, classValue = double>
Histo::OneDBinList<Count, Value>::OneDBinList<Count, Value> ( const int num_bins )
 

Definition at line 39 of file histogram.h.


Member Function Documentation

template<classCount = int, classValue = double>
OneDBinList<Count, Value> & Histo::OneDBinList<Count, Value>::add ( size_type bin,
Value val = 1 ) [inline]
 

Add the specified value to the histogram bin specified.

Definition at line 44 of file histogram.h.

template<classCount = int, classValue = double>
Count Histo::OneDBinList<Count, Value>::count ( size_type i ) const [inline]
 

Definition at line 75 of file histogram.h.

template<classCount = int, classValue = double>
double Histo::OneDBinList<Count, Value>::count_percent ( size_type i ) const [inline]
 

Definition at line 77 of file histogram.h.

template<classCount = int, classValue = double>
Count Histo::OneDBinList<Count, Value>::max_count ( ) const [inline]
 

Definition at line 65 of file histogram.h.

template<classCount = int, classValue = double>
Value Histo::OneDBinList<Count, Value>::max_value ( ) const [inline]
 

Definition at line 63 of file histogram.h.

template<classCount = int, classValue = double>
Count Histo::OneDBinList<Count, Value>::min_count ( ) const [inline]
 

Definition at line 66 of file histogram.h.

template<classCount = int, classValue = double>
Value Histo::OneDBinList<Count, Value>::min_value ( ) const [inline]
 

Definition at line 64 of file histogram.h.

template<classCount = int, classValue = double>
size_type Histo::OneDBinList<Count, Value>::num_bins ( ) const [inline]
 

Definition at line 57 of file histogram.h.

template<classCount = int, classValue = double>
Count Histo::OneDBinList<Count, Value>::total_count ( ) const [inline]
 

Not merely the count of the current values, if histogram is a difference.

Definition at line 61 of file histogram.h.

template<classCount = int, classValue = double>
Value Histo::OneDBinList<Count, Value>::total_value ( ) const [inline]
 

Not merely the sum of the current values, if histogram is a difference.

Definition at line 59 of file histogram.h.

template<classCount = int, classValue = double>
Value Histo::OneDBinList<Count, Value>::value ( size_type i ) const [inline]
 

Definition at line 74 of file histogram.h.

template<classCount = int, classValue = double>
double Histo::OneDBinList<Count, Value>::value_percent ( size_type i ) const [inline]
 

Definition at line 76 of file histogram.h.


Member Data Documentation

template<classCount = int, classValue = double>
vector< Count > Histo::OneDBinList<Count, Value>::counts [protected]
 

Definition at line 28 of file histogram.h.

template<classCount = int, classValue = double>
Count Histo::OneDBinList<Count, Value>::total_c [protected]
 

Definition at line 30 of file histogram.h.

template<classCount = int, classValue = double>
Value Histo::OneDBinList<Count, Value>::total_v [protected]
 

Definition at line 31 of file histogram.h.

template<classCount = int, classValue = double>
vector< Value > Histo::OneDBinList<Count, Value>::values [protected]
 

Definition at line 29 of file histogram.h.


The documentation for this class was generated from the following file:
Generated at Mon Aug 21 00:31:20 2000 for RF-LISSOM by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000