gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Stats::StandardDeviation Class Reference

Calculates the mean and variance of all the samples. More...

#include <statistics.hh>

Inheritance diagram for Stats::StandardDeviation:
Stats::DistBase< StandardDeviation, SampleStor > Stats::DataWrap< StandardDeviation, DistInfoProxy > Stats::InfoAccess

Public Member Functions

 StandardDeviation ()
 Construct and initialize this distribution. More...
 
- Public Member Functions inherited from Stats::DistBase< StandardDeviation, SampleStor >
 DistBase ()
 
void sample (const U &v, int n=1)
 Add a value to the distribtion n times. More...
 
size_type size () const
 Return the number of entries in this stat. More...
 
bool zero () const
 Return true if no samples have been added. More...
 
void prepare ()
 
void reset ()
 Reset stat value to default. More...
 
void add (DistBase &d)
 Add the argument distribution to the this distribution. More...
 
- Public Member Functions inherited from Stats::DataWrap< StandardDeviation, DistInfoProxy >
const Infoinfo () const
 
 DataWrap ()
 
StandardDeviationname (const std::string &name)
 Set the name and marks this stat to print at the end of simulation. More...
 
const std::string & name () const
 
StandardDeviationsetSeparator (const std::string &_sep)
 Set the character(s) used between the name and vector number on vectors, dist, etc. More...
 
const std::string & setSeparator () const
 
StandardDeviationdesc (const std::string &_desc)
 Set the description and marks this stat to print at the end of simulation. More...
 
StandardDeviationprecision (int _precision)
 Set the precision and marks this stat to print at the end of simulation. More...
 
StandardDeviationflags (Flags _flags)
 Set the flags and marks this stat to print at the end of simulation. More...
 
StandardDeviationprereq (const Stat &prereq)
 Set the prerequisite stat and marks this stat to print at the end of simulation. More...
 
- Public Member Functions inherited from Stats::InfoAccess
void reset ()
 Reset the stat to the default state. More...
 
bool zero () const
 
bool check () const
 Check that this stat has been set up properly and is ready for use. More...
 

Additional Inherited Members

- Public Types inherited from Stats::DistBase< StandardDeviation, SampleStor >
typedef DistInfoProxy
< StandardDeviation
Info
 
typedef SampleStor Storage
 
typedef SampleStor::Params Params
 
- Public Types inherited from Stats::DataWrap< StandardDeviation, DistInfoProxy >
typedef DistInfoProxy
< StandardDeviation
Info
 
- Protected Member Functions inherited from Stats::DistBase< StandardDeviation, SampleStor >
char storage[sizeof(Storage)] __attribute__ ((aligned(8)))
 The storage for this stat. More...
 
Storagedata ()
 Retrieve the storage. More...
 
const Storagedata () const
 Retrieve a const pointer to the storage. More...
 
void doInit ()
 
- Protected Member Functions inherited from Stats::DataWrap< StandardDeviation, DistInfoProxy >
StandardDeviationself ()
 
Infoinfo ()
 
 DataWrap (const DataWrap &stat)
 Copy constructor, copies are not allowed. More...
 
void operator= (const DataWrap &)
 Can't copy stats. More...
 
- Protected Member Functions inherited from Stats::InfoAccess
void setInfo (Info *info)
 Set up an info class for this statistic. More...
 
void setParams (const StorageParams *params)
 Save Storage class parameters if any. More...
 
void setInit ()
 Save Storage class parameters if any. More...
 
Infoinfo ()
 Grab the information class for this statistic. More...
 
const Infoinfo () const
 Grab the information class for this statistic. More...
 

Detailed Description

Calculates the mean and variance of all the samples.

See Also
DistBase, SampleStor

Definition at line 2574 of file statistics.hh.

Constructor & Destructor Documentation

Stats::StandardDeviation::StandardDeviation ( )
inline

Construct and initialize this distribution.

Definition at line 2580 of file statistics.hh.

References Stats::DistBase< StandardDeviation, SampleStor >::doInit(), and Stats::InfoAccess::setParams().


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

Generated on Fri Jun 9 2017 13:04:39 for gem5 by doxygen 1.8.6