A class for sampling a signal and calculating statistics.
More...
#include <itpp/stat/misc_stat.h>
|
| 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)
|
|
A class for sampling a signal and calculating statistics.
Definition at line 48 of file misc_stat.h.
◆ Stat()
◆ ~Stat()
virtual itpp::Stat::~Stat |
( |
| ) |
|
|
inlinevirtual |
◆ clear()
virtual void itpp::Stat::clear |
( |
| ) |
|
|
inlinevirtual |
◆ sample()
virtual void itpp::Stat::sample |
( |
const double | s, |
|
|
const bool | overflow = false ) |
|
inlinevirtual |
◆ n_overflows()
int itpp::Stat::n_overflows |
( |
| ) |
const |
|
inline |
◆ n_samples()
int itpp::Stat::n_samples |
( |
| ) |
const |
|
inline |
◆ n_zeros()
int itpp::Stat::n_zeros |
( |
| ) |
const |
|
inline |
◆ avg()
double itpp::Stat::avg |
( |
| ) |
const |
|
inline |
◆ max()
double itpp::Stat::max |
( |
| ) |
const |
|
inline |
◆ min()
double itpp::Stat::min |
( |
| ) |
const |
|
inline |
◆ sigma()
double itpp::Stat::sigma |
( |
| ) |
const |
|
inline |
◆ sqr_sum()
double itpp::Stat::sqr_sum |
( |
| ) |
const |
|
inline |
◆ sum()
double itpp::Stat::sum |
( |
| ) |
const |
|
inline |
◆ histogram()
vec itpp::Stat::histogram |
( |
| ) |
const |
|
inline |
◆ _n_overflows
int itpp::Stat::_n_overflows |
|
protected |
◆ _n_samples
int itpp::Stat::_n_samples |
|
protected |
◆ _n_zeros
◆ _max
◆ _min
◆ _sqr_sum
double itpp::Stat::_sqr_sum |
|
protected |
◆ _sum
The documentation for this class was generated from the following file: