hpp::statistics::Statistics< T > Class Template Reference

Template class to do statistics. More...

#include <hpp/statistics/bin.hh>

List of all members.

Public Types

typedef std::list< T > Container
typedef Container::iterator iterator
typedef Container::const_iterator const_iterator

Public Member Functions

virtual size_t freq (const T &bin) const
 Return the number of occurence of a Bin.
virtual Proba_t relativeFreq (const T &bin) const
 Return the relative frequency of a Bin.
unsigned int numberOfObservations () const
 Return the number of times a observation has recorded.
virtual std::ostream & print (std::ostream &os) const
 Put the results in a stream.
const_iterator find (const T &bin) const
template<typename U >
const_iterator find (const U &value) const
const_iterator begin () const
 Return an iterator pointing at the beginning of the set of bins.
const_iterator end () const
 Return an iterator pointing at the end of the set of bins.

Protected Member Functions

 Statistics ()
 Constructor.
virtual T & increment (const T &bin) __attribute__((deprecated))
 Increment a Bin.
virtual iterator insert (const T &bin)
 insert a Bin.

Detailed Description

template<typename T>
class hpp::statistics::Statistics< T >

Template class to do statistics.

You should derivate class Bin and construct a class Statistics < YourBin >.


Member Typedef Documentation

template<typename T>
typedef Container::const_iterator hpp::statistics::Statistics< T >::const_iterator
template<typename T>
typedef std::list< T > hpp::statistics::Statistics< T >::Container
template<typename T>
typedef Container::iterator hpp::statistics::Statistics< T >::iterator

Constructor & Destructor Documentation

template<typename T >
hpp::statistics::Statistics< T >::Statistics ( ) [protected]

Constructor.


Member Function Documentation

template<typename T>
const_iterator hpp::statistics::Statistics< T >::begin ( ) const [inline]

Return an iterator pointing at the beginning of the set of bins.

Referenced by hpp::statistics::Statistics< T >::increment(), and hpp::statistics::Statistics< T >::insert().

template<typename T>
const_iterator hpp::statistics::Statistics< T >::end ( ) const [inline]

Return an iterator pointing at the end of the set of bins.

Referenced by hpp::statistics::Statistics< T >::find().

template<typename T>
Statistics< T >::const_iterator hpp::statistics::Statistics< T >::find ( const T &  bin) const
template<typename T >
template<typename U >
Statistics< T >::const_iterator hpp::statistics::Statistics< T >::find ( const U &  value) const
template<typename T>
size_t hpp::statistics::Statistics< T >::freq ( const T &  bin) const [virtual]

Return the number of occurence of a Bin.

Parameters:
bina Bin for which only the value is useful.
Note:
It searches for the equivalent Bin is the set and returns the frequency of the result.

References hpp::statistics::Statistics< T >::freq().

Referenced by hpp::statistics::Statistics< T >::freq(), and hpp::statistics::Statistics< T >::relativeFreq().

template<typename T>
T & hpp::statistics::Statistics< T >::increment ( const T &  bin) [protected, virtual]

Increment a Bin.

Note:
bin is inserted in the set of bins if it was not already in the set.

References hpp::statistics::Statistics< T >::begin().

template<typename T>
Statistics< T >::iterator hpp::statistics::Statistics< T >::insert ( const T &  bin) [protected, virtual]

insert a Bin.

Note:
bin is inserted in the set of bins if it was not already in the set.

References hpp::statistics::Statistics< T >::begin().

template<typename T>
unsigned int hpp::statistics::Statistics< T >::numberOfObservations ( ) const [inline]

Return the number of times a observation has recorded.

It is the total number of observations.

template<typename T >
std::ostream & hpp::statistics::Statistics< T >::print ( std::ostream &  os) const [virtual]

Put the results in a stream.

template<typename T>
Proba_t hpp::statistics::Statistics< T >::relativeFreq ( const T &  bin) const [virtual]

Return the relative frequency of a Bin.

Parameters:
bina Bin for which only the value is useful.
Note:
It searches for the equivalent Bin is the set and returns the frequency of the result.

References hpp::statistics::Statistics< T >::freq().