Histogram Class Reference
[Statistics]

Constructs and maintains a histogram of input data. More...

#include <rw/histo.h>

Inheritance diagram for Histogram:

List of all members.

Public Member Functions
	Histogram ()
	Histogram (size_t nbins, const RWMathVec< double > &v)
	Histogram (const RWMathVec< double > &b)
	Histogram (size_t nbins, double min, double max)
	Histogram (const Histogram &)
size_t	larger () const
size_t	smaller () const
size_t	bins () const
size_t	totalCount () const
RWMathVec< double >	binBoundaries () const
void	addCount (double a)
void	addCount (const RWMathVec< double > &v)
Histogram &	resetCounts ()
Histogram &	operator= (const Histogram &h)
size_t	binaryStoreSize () const
Friends
std::ostream &	operator<< (std::ostream &s, const Histogram &h)

---

Detailed Description

The class Histogram constructs and maintains a histogram of input data. The count is stored as a public RWMathVec<int> base class. It can be used anywhere an RWMathVec<int> can be used.

Synopsis

 #include <rw/histo.h>
 #include <rw/math/mathvec.h>
 RWMathVec<double> v;
 unsigned n;
 Histogram H(n, v);

---

Constructor & Destructor Documentation

Histogram::Histogram

(

)

Constructs a histogram with 0 bins.

Histogram::Histogram	(	size_t	nbins,
		const RWMathVec< double > &	v
	)

Constructs a histogram from the data in v, with nbins bins of data. The bins are of equal size and are scaled with the maximum and minimum data in v. The count in the histogram is initialized with the contents of v.

Histogram::Histogram

(

const RWMathVec< double > &

b

)

Constructs a histogram with no initial data, with bin boundaries defined by the data in b. The number of bins is b.length()-1.

Histogram::Histogram	(	size_t	nbins,
		double	min,
		double	max
	)

Constructs a histogram with no initial data, with nbins bins. The bins are of equal size and are scaled with max and min.

Histogram::Histogram

(

const Histogram &

)

Copy constructor. The new histogram does not reference the old histogram's data.

---

Member Function Documentation

void Histogram::addCount

(

const RWMathVec< double > &

v

)

Adds the contents of the vector v to the histogram.

void Histogram::addCount

(

double

a

)

Adds data value a to the histogram.

size_t Histogram::binaryStoreSize

(

)

const

Returns the number of bytes required to store the vector to an RWFile using member function saveOn(RWFile&).

Reimplemented from RWMathVec< int >.

RWMathVec<double> Histogram::binBoundaries

(

)

const [inline]

Returns the boundaries of the histogram's bins as a vector.

size_t Histogram::bins

(

)

const [inline]

Returns the number of bins.

size_t Histogram::larger

(

)

const [inline]

Returns the total accumulated number of data values that are greater than the largest bin.

Histogram& Histogram::operator=

(

const Histogram &

h

)

Assignment operator. Self is a copy of the data in h.

Histogram& Histogram::resetCounts

(

)

Removes all data values from the histogram. Each bin count, including larger and smaller counts, is set to 0. The bin boundaries are retained. Returns a reference to self.

size_t Histogram::smaller

(

)

const [inline]

Returns the total accumulated number of data values that are less than the smallest bin.

size_t Histogram::totalCount

(

)

const [inline]

Returns the total accumulated number of data values in the histogram. This the sum of all the bin counts, plus the number of data values that are smaller than the smallest bin, and the number of data values that are larger than the largest bin.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	s,
		const Histogram &	h
	)			[friend]

Outputs a summary of the histogram h on std::ostream s.