gem5  v21.1.0.2
Public Member Functions | List of all members
gem5::statistics::StandardDeviation Class Reference

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

#include <statistics.hh>

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

Public Member Functions

 StandardDeviation (Group *parent=nullptr)
 Construct and initialize this distribution. More...
 
 StandardDeviation (Group *parent, const char *name, const char *desc=nullptr)
 
 StandardDeviation (Group *parent, const char *name, const units::Base *unit, const char *desc=nullptr)
 
- Public Member Functions inherited from gem5::statistics::DistBase< StandardDeviation, SampleStor >
 DistBase (Group *parent, const char *name, const units::Base *unit, const char *desc)
 
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 gem5::statistics::DataWrap< StandardDeviation, DistInfoProxy >
const Infoinfo () const
 
 DataWrap ()=delete
 
 DataWrap (const DataWrap &)=delete
 
 DataWrap (Group *parent, const char *name, const units::Base *unit, const char *desc)
 
DataWrapoperator= (const DataWrap &)=delete
 
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
 
StandardDeviationunit (const units::Base *_unit)
 Set the unit of the stat. More...
 
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 gem5::statistics::InfoAccess
 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 gem5::statistics::DistBase< StandardDeviation, SampleStor >
typedef DistInfoProxy< StandardDeviationInfo
 
typedef SampleStor Storage
 
typedef SampleStor ::Params Params
 
- Public Types inherited from gem5::statistics::DataWrap< StandardDeviation, DistInfoProxy >
typedef DistInfoProxy< StandardDeviationInfo
 
- Protected Member Functions inherited from gem5::statistics::DistBase< StandardDeviation, SampleStor >
 GEM5_ALIGNED (8) char storage[sizeof(Storage)]
 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 gem5::statistics::DataWrap< StandardDeviation, DistInfoProxy >
StandardDeviationself ()
 
Infoinfo ()
 
- Protected Member Functions inherited from gem5::statistics::InfoAccess
void setInfo (Group *parent, 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 2164 of file statistics.hh.

Constructor & Destructor Documentation

◆ StandardDeviation() [1/3]

gem5::statistics::StandardDeviation::StandardDeviation ( Group parent = nullptr)
inline

Construct and initialize this distribution.

Definition at line 2170 of file statistics.hh.

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

◆ StandardDeviation() [2/3]

gem5::statistics::StandardDeviation::StandardDeviation ( Group parent,
const char *  name,
const char *  desc = nullptr 
)
inline

◆ StandardDeviation() [3/3]

gem5::statistics::StandardDeviation::StandardDeviation ( Group parent,
const char *  name,
const units::Base unit,
const char *  desc = nullptr 
)
inline

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

Generated on Tue Sep 21 2021 12:32:30 for gem5 by doxygen 1.8.17