InfiniteHistogramBin< T > Class Template Reference
[StatisticalDataStructures]

Histogram bin that is infinite in either the +ve or -ve direction. More...

#include <Histogram.h>

Inheritance diagram for InfiniteHistogramBin< T >:

List of all members.

Public Member Functions
	InfiniteHistogramBin (const InfiniteHistogramBin< T > &toCopy)
	InfiniteHistogramBin (const T &bound, bool positive)
	Create a new InfiniteHistogramBin.
	InfiniteHistogramBin (const T &bound, bool positive, bool incl)
	Create a new InfiniteHistogramBin.
virtual InfiniteHistogramBin< T > *	clone (void) const
virtual bool	isInBin (const T &value) const
	Check whether an item belongs in this bin.
virtual std::string	toString (void) const
virtual double	getValue (void) const
	return the 'count' of items in the bin
virtual void	addValue (const T &value) throw ( ValueOutOfRangeException )
	Add a value to the bin.
virtual void	clear (void)
	Clear the value of the bin.
Protected Attributes
T	lowerBound
bool	lowerInclusive
T	upperBound
bool	upperInclusive
double	binValue
double	increment

---

Detailed Description

template<class T>
class InfiniteHistogramBin< T >

Histogram bin that is infinite in either the +ve or -ve direction.

---

Constructor & Destructor Documentation

template<class T> InfiniteHistogramBin< T >::InfiniteHistogramBin (  const T &  bound, bool  positive )

Create a new InfiniteHistogramBin. Note: default inclusiveness - finite lower bound will be non-inclusive, finite upper bound will be inclusive

template<class T> InfiniteHistogramBin< T >::InfiniteHistogramBin (  const T &  bound, bool  positive, bool  incl )

Create a new InfiniteHistogramBin. Overrides the default behaviour of inclusiveness.

---

Member Function Documentation

template<class T> void HistogramBin< T >::addValue (  const T &  value  )  throw ( ValueOutOfRangeException ) [virtual, inherited]

Add a value to the bin. Exceptions: ValueOutOfRangeException  The value to be added to the bin is not within the range assigned to the bin.

template<class T> double HistogramBin< T >::getValue (  void   )  const [virtual, inherited]

return the 'count' of items in the bin Returns: value of the bin, normally a count of items in the bin, possibly normalized (hence the double return type)

---

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

• data_structures/Histogram.h
• data_structures/Histogram.cc

---