Edinburgh Speech Tools 2.4-release
 
Loading...
Searching...
No Matches
EST_SuffStats Class Reference

#include <include/EST_simplestats.h>

Public Member Functions

 EST_SuffStats (double in, double isum, double isumx)
 
 EST_SuffStats (const EST_SuffStats &s)
 
void copy (const EST_SuffStats &s)
 
void reset (void)
 reset internal values
 
void set (double in, double isum, double isumx)
 
double samples (void)
 number of samples in set
 
double sum ()
 sum of values
 
double sumx ()
 sum of squared values
 
double mean (void) const
 mean of currently cummulated values
 
double variance (void) const
 variance of currently cummulated values
 
double stddev (void) const
 standard deviation of currently cummulated values
 
void cumulate (double a, double count=1.0)
 
EST_SuffStatsoperator+= (double a)
 Used to cummulate new values.
 
EST_SuffStatsoperator+ (double a)
 Used to cummulate new values.
 
EST_SuffStatsoperator= (const EST_SuffStats &a)
 

Detailed Description

A class for cummulating `‘sufficient statistics’' for a set of numbers: sum, count, sum squared.

This collects the number, sum and sum squared for a set of number. Offering mean, variance and standard deviation derived from the cummulated values.

Author
Alan W Black (awb@c.nosp@m.str..nosp@m.ed.ac.nosp@m..uk): July 1996

Definition at line 136 of file EST_simplestats.h.

Constructor & Destructor Documentation

◆ EST_SuffStats() [1/3]

EST_SuffStats::EST_SuffStats ( )
inline

Definition at line 143 of file EST_simplestats.h.

◆ EST_SuffStats() [2/3]

EST_SuffStats::EST_SuffStats ( double in,
double isum,
double isumx )
inline

Definition at line 145 of file EST_simplestats.h.

◆ EST_SuffStats() [3/3]

EST_SuffStats::EST_SuffStats ( const EST_SuffStats & s)
inline

Definition at line 148 of file EST_simplestats.h.

Member Function Documentation

◆ copy()

void EST_SuffStats::copy ( const EST_SuffStats & s)
inline

Definition at line 150 of file EST_simplestats.h.

◆ reset()

void EST_SuffStats::reset ( void )
inline

reset internal values

Definition at line 153 of file EST_simplestats.h.

◆ set()

void EST_SuffStats::set ( double in,
double isum,
double isumx )
inline

Definition at line 154 of file EST_simplestats.h.

◆ samples()

double EST_SuffStats::samples ( void )
inline

number of samples in set

Definition at line 157 of file EST_simplestats.h.

◆ sum()

double EST_SuffStats::sum ( )
inline

sum of values

Definition at line 159 of file EST_simplestats.h.

◆ sumx()

double EST_SuffStats::sumx ( )
inline

sum of squared values

Definition at line 161 of file EST_simplestats.h.

◆ mean()

double EST_SuffStats::mean ( void ) const
inline

mean of currently cummulated values

Definition at line 163 of file EST_simplestats.h.

◆ variance()

double EST_SuffStats::variance ( void ) const
inline

variance of currently cummulated values

Definition at line 165 of file EST_simplestats.h.

◆ stddev()

double EST_SuffStats::stddev ( void ) const
inline

standard deviation of currently cummulated values

Definition at line 168 of file EST_simplestats.h.

◆ cumulate()

void EST_SuffStats::cumulate ( double a,
double count = 1.0 )
inline

Definition at line 170 of file EST_simplestats.h.

◆ operator+=()

EST_SuffStats & EST_SuffStats::operator+= ( double a)
inline

Used to cummulate new values.

Definition at line 174 of file EST_simplestats.h.

◆ operator+()

EST_SuffStats & EST_SuffStats::operator+ ( double a)
inline

Used to cummulate new values.

Definition at line 177 of file EST_simplestats.h.

◆ operator=()

EST_SuffStats & EST_SuffStats::operator= ( const EST_SuffStats & a)
inline

Definition at line 180 of file EST_simplestats.h.


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