User Manual, Developers Guide and API Documentation

wns::evaluation::statistics::StatEval Class Reference

Class StatEval: Base class for statistical evaluation.

#include <evaluation/statistics/stateval.hpp>

Inheritance diagram for wns::evaluation::statistics::StatEval:

Inheritance graph
[legend]
Collaboration diagram for wns::evaluation::statistics::StatEval:

Collaboration graph
[legend]

List of all members.

Public Types

enum  formatType { fixed, scientific }
 How to format the output of numbers. More...
enum  functionType { df, cdf, pf }
 Type of evaluation. More...
enum  statEvalType {
  all = 0, lref, lreg, plref,
  plreg, moments, pmoments, batchMns,
  pbatchMns, histogrm, phistogrm, dlref,
  dlreg, dlrep, pdlref, pdlreg,
  pdlrep, dlref_nonequi, dlreg_nonequi, dlrep_nonequi,
  pdlref_nonequi, pdlreg_nonequi, pdlrep_nonequi, pdf,
  ppdf, logeval, plogeval, probetext,
  pprobetext, unknown
}
 Type of statistical evaluation. More...

Public Member Functions

virtual double coeffOfVariation () const
 Return coefficient of variation.
virtual double deviation () const
 Return standard deviation.
virtual const std::string & getDesc () const
 Get description.
virtual formatType getFormat () const
 Get the output format: fixed or scientific.
virtual const std::string & getName () const
 Get name of.
virtual double M2 () const
 Return moment m2.
virtual double M3 () const
 Return moment m3.
virtual double max () const
 maximal value of trials
virtual double mean () const
 Return mean value.
virtual double min () const
 minimal value of trials
virtual void print (std::ostream &stream) const
 Print output.
virtual void printLog (std::ostream &stream)
virtual void put (double xI)
 put a value to evaluation
virtual double relativeDeviation () const
 Return relative standard deviation.
virtual double relativeVariance () const
 Relative variance.
virtual void reset ()
 Reset evaluation.
virtual void setFormat (formatType format)
 Set the output format: fixed or scientific.
virtual double skewness () const
 Return skewness.
 StatEval (const wns::pyconfig::View &config)
 StatEval (formatType format, std::string name, std::string desc)
virtual unsigned long int trials () const
 Return number of trials.
virtual double variance () const
 Return variance.
virtual double Z3 () const
 Return z3.
virtual ~StatEval ()

Static Public Member Functions

static std::string mapEvalTypeToString (statEvalType)
 map string to statEvalType
static statEvalType mapToStatEvalType (std::string type)
 map string to statEvalType

Protected Member Functions

void printBanner (std::ostream &stream, std::string probeTypeDesc, std::string errorString) const

Protected Attributes

double cubeSum_
 Cube sum of collected values.
std::string desc_
 Description.
StatEval::formatType format_
 Format of numbers (fixed, scientific).
double maxValue_
 Maximum value of all collected trials.
double minValue_
 Minimum value of all collected trials.
std::string name_
 Name.
unsigned long int numTrials_
 number of collected trials
std::string prefix_
 Comment prefix to be used in output files.
double scalingFactor_
 Scaling factor for incoming values.
double squareSum_
 Square sum of collected values.
double sum_
 Sum of collected values.


Detailed Description

Definition at line 74 of file stateval.hpp.


Member Enumeration Documentation

Enumerator:
fixed 
scientific 

Definition at line 91 of file stateval.hpp.

Enumerator:
df 
cdf 
pf 

Definition at line 80 of file stateval.hpp.

Enumerator:
all 
lref 
lreg 
plref 
plreg 
moments 
pmoments 
batchMns 
pbatchMns 
histogrm 
phistogrm 
dlref 
dlreg 
dlrep 
pdlref 
pdlreg 
pdlrep 
dlref_nonequi 
dlreg_nonequi 
dlrep_nonequi 
pdlref_nonequi 
pdlreg_nonequi 
pdlrep_nonequi 
pdf 
ppdf 
logeval 
plogeval 
probetext 
pprobetext 
unknown 

Definition at line 118 of file stateval.hpp.


Constructor & Destructor Documentation

StatEval::StatEval ( formatType  format,
std::string  name,
std::string  desc 
)

Definition at line 48 of file stateval.cpp.

StatEval::StatEval ( const wns::pyconfig::View config  ) 

Definition at line 66 of file stateval.cpp.

StatEval::~StatEval (  )  [virtual]

Definition at line 80 of file stateval.cpp.


Member Function Documentation

double StatEval::coeffOfVariation (  )  const [virtual]

Definition at line 166 of file stateval.cpp.

double StatEval::deviation (  )  const [virtual]

Definition at line 237 of file stateval.cpp.

const std::string & StatEval::getDesc (  )  const [virtual]

Definition at line 289 of file stateval.cpp.

StatEval::formatType StatEval::getFormat (  )  const [virtual]

Definition at line 301 of file stateval.cpp.

const std::string & StatEval::getName (  )  const [virtual]

Implements wns::evaluation::statistics::StatEvalInterface.

Definition at line 283 of file stateval.cpp.

double StatEval::M2 (  )  const [virtual]

Reimplemented in wns::evaluation::statistics::Moments.

Definition at line 174 of file stateval.cpp.

double StatEval::M3 (  )  const [virtual]

Reimplemented in wns::evaluation::statistics::Moments.

Definition at line 181 of file stateval.cpp.

std::string StatEval::mapEvalTypeToString ( statEvalType  statType  )  [static]

Definition at line 434 of file stateval.cpp.

StatEval::statEvalType StatEval::mapToStatEvalType ( std::string  type  )  [static]

Definition at line 307 of file stateval.cpp.

double StatEval::max (  )  const [virtual]

Definition at line 266 of file stateval.cpp.

double StatEval::mean (  )  const [virtual]

Reimplemented in wns::evaluation::statistics::Moments.

Definition at line 118 of file stateval.cpp.

double StatEval::min (  )  const [virtual]

Definition at line 260 of file stateval.cpp.

void StatEval::print ( std::ostream &  stream  )  const [virtual]

void wns::evaluation::statistics::StatEval::printBanner ( std::ostream &  stream,
std::string  probeTypeDesc,
std::string  errorString 
) const [protected]

@ brief Print the banner containing common statistics

void StatEval::printLog ( std::ostream &   )  [virtual]

Todo:
dbn: This was introduced to handle LogEval in some way. LogEvals flush their contents completely to disk and thus cannot be const. We should think of a generic way to handle both possibilities behind a common interface.

Implements wns::evaluation::statistics::StatEvalInterface.

Definition at line 93 of file stateval.cpp.

void StatEval::put ( double  xI  )  [virtual]

double StatEval::relativeDeviation (  )  const [virtual]

Definition at line 244 of file stateval.cpp.

double StatEval::relativeVariance (  )  const [virtual]

Definition at line 150 of file stateval.cpp.

void StatEval::reset (  )  [virtual]

void StatEval::setFormat ( formatType  format  )  [virtual]

Definition at line 295 of file stateval.cpp.

double StatEval::skewness (  )  const [virtual]

Definition at line 228 of file stateval.cpp.

unsigned long int StatEval::trials (  )  const [virtual]

Definition at line 254 of file stateval.cpp.

double StatEval::variance (  )  const [virtual]

Reimplemented in wns::evaluation::statistics::Moments.

Definition at line 124 of file stateval.cpp.

double StatEval::Z3 (  )  const [virtual]

Definition at line 188 of file stateval.cpp.


Member Data Documentation

Definition at line 298 of file stateval.hpp.

Definition at line 313 of file stateval.hpp.

Definition at line 303 of file stateval.hpp.

Definition at line 278 of file stateval.hpp.

Definition at line 273 of file stateval.hpp.

Reimplemented in wns::evaluation::statistics::PDF.

Definition at line 308 of file stateval.hpp.

Definition at line 283 of file stateval.hpp.

Definition at line 318 of file stateval.hpp.

Definition at line 323 of file stateval.hpp.

Definition at line 293 of file stateval.hpp.

Definition at line 288 of file stateval.hpp.


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

Generated on Sat May 26 03:32:53 2012 for openWNS by  doxygen 1.5.5