itpp::Stat Class Reference
[Statistics]

A class for sampling a signal and calculating statistics. More...

#include <itpp/base/stat.h>

List of all members.

Public Member Functions
	Stat ()
	Default constructor.
virtual	~Stat ()
	Destructor.
virtual void	clear ()
	Clear statistics.
virtual void	sample (const double s, const bool overflow=false)
	Register a sample and flag for overflow.
int	n_overflows () const
	Number of reported overflows.
int	n_samples () const
	Number of samples.
int	n_zeros () const
	Number of zero samples.
double	avg () const
	Average over all samples.
double	max () const
	Maximum sample.
double	min () const
	Minimum sample.
double	sigma () const
	Standard deviation of all samples.
double	sqr_sum () const
	Squared sum of all samples.
double	sum () const
	Sum of all samples.
vec	histogram () const
	Histogram over all samples (not implemented yet).
Protected Attributes
int	_n_overflows
	Number of reported overflows.
int	_n_samples
	Number of samples.
int	_n_zeros
	Number of zero samples.
double	_max
	Maximum sample.
double	_min
	Minimum sample.
double	_sqr_sum
	Squared sum of all samples.
double	_sum
	Sum of all samples.

---

Detailed Description

A class for sampling a signal and calculating statistics.

Definition at line 51 of file stat.h.

---

Constructor & Destructor Documentation

itpp::Stat::Stat

(

)

[inline]

Default constructor.

Definition at line 54 of file stat.h.

References clear().

virtual itpp::Stat::~Stat

(

)

[inline, virtual]

Destructor.

Definition at line 56 of file stat.h.

---

Member Function Documentation

virtual void itpp::Stat::clear

(

)

[inline, virtual]

Clear statistics.

Definition at line 59 of file stat.h.

References _max, _min, _n_overflows, _n_samples, _n_zeros, _sqr_sum, and _sum.

Referenced by Stat().

virtual void itpp::Stat::sample	(	const double	s,
		const bool	overflow = false
	)			[inline, virtual]

Register a sample and flag for overflow.

Definition at line 71 of file stat.h.

References _max, _min, _n_overflows, _n_samples, _n_zeros, _sqr_sum, and _sum.

Referenced by itpp::Fix_Base::apply_o_mode(), and itpp::Fix_Base::rshift_and_apply_q_mode().

int itpp::Stat::n_overflows

(

)

const [inline]

Number of reported overflows.

Definition at line 83 of file stat.h.

References _n_overflows.

int itpp::Stat::n_samples

(

)

const [inline]

Number of samples.

Definition at line 85 of file stat.h.

References _n_samples.

int itpp::Stat::n_zeros

(

)

const [inline]

Number of zero samples.

Definition at line 87 of file stat.h.

References _n_zeros.

double itpp::Stat::avg

(

)

const [inline]

Average over all samples.

Definition at line 89 of file stat.h.

References _n_samples, and _sum.

Referenced by sigma().

double itpp::Stat::max

(

)

const [inline]

Maximum sample.

Definition at line 91 of file stat.h.

References _max.

double itpp::Stat::min

(

)

const [inline]

Minimum sample.

Definition at line 93 of file stat.h.

References _min.

double itpp::Stat::sigma

(

)

const [inline]

Standard deviation of all samples.

Definition at line 95 of file stat.h.

References _n_samples, _sqr_sum, avg(), and itpp::sqrt().

double itpp::Stat::sqr_sum

(

)

const [inline]

Squared sum of all samples.

Definition at line 101 of file stat.h.

References _sqr_sum.

double itpp::Stat::sum

(

)

const [inline]

Sum of all samples.

Definition at line 103 of file stat.h.

References _sum.

vec itpp::Stat::histogram

(

)

const [inline]

Histogram over all samples (not implemented yet).

Definition at line 105 of file stat.h.

---

Member Data Documentation

int itpp::Stat::_n_overflows [protected]

Number of reported overflows.

Definition at line 109 of file stat.h.

Referenced by clear(), n_overflows(), and sample().

int itpp::Stat::_n_samples [protected]

Number of samples.

Definition at line 111 of file stat.h.

Referenced by avg(), clear(), n_samples(), sample(), and sigma().

int itpp::Stat::_n_zeros [protected]

Number of zero samples.

Definition at line 113 of file stat.h.

Referenced by clear(), n_zeros(), and sample().

double itpp::Stat::_max [protected]

Maximum sample.

Definition at line 115 of file stat.h.

Referenced by clear(), max(), and sample().

double itpp::Stat::_min [protected]

Minimum sample.

Definition at line 117 of file stat.h.

Referenced by clear(), min(), and sample().

double itpp::Stat::_sqr_sum [protected]

Squared sum of all samples.

Definition at line 119 of file stat.h.

Referenced by clear(), sample(), sigma(), and sqr_sum().

double itpp::Stat::_sum [protected]

Sum of all samples.

Definition at line 121 of file stat.h.

Referenced by avg(), clear(), sample(), and sum().

---

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

• itpp/base/stat.h

Generated on Wed Apr 18 11:23:40 2007 for IT++ by Doxygen 1.5.2