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

A stat that calculates the per tick average of a value. More...

#include <statistics.hh>

Inheritance diagram for gem5::statistics::Average:
gem5::statistics::ScalarBase< Average, AvgStor > gem5::statistics::DataWrap< Average, ScalarInfoProxy > gem5::statistics::InfoAccess

Public Member Functions

 Average (Group *parent=nullptr)
 
 Average (Group *parent, const char *name, const char *desc=nullptr)
 
 Average (Group *parent, const char *name, const units::Base *unit, const char *desc=nullptr)
 
- Public Member Functions inherited from gem5::statistics::ScalarBase< Average, AvgStor >
 ScalarBase (Group *parent=nullptr, const char *name=nullptr, const units::Base *unit=units::Unspecified::get(), const char *desc=nullptr)
 
void operator++ ()
 Increment the stat by 1. More...
 
void operator++ (int)
 Increment the stat by 1. More...
 
void operator-- ()
 Decrement the stat by 1. More...
 
void operator-- (int)
 Decrement the stat by 1. More...
 
void operator= (const U &v)
 Set the data value to the given value. More...
 
void operator+= (const U &v)
 Increment the stat by the given value. More...
 
void operator-= (const U &v)
 Decrement the stat by the given value. More...
 
size_type size () const
 Return the number of elements, always 1 for a scalar. More...
 
Counter value () const
 Return the current value of this stat as its base type. More...
 
Result result () const
 
Result total () const
 
bool zero () const
 
void reset ()
 
void prepare ()
 
- Public Member Functions inherited from gem5::statistics::DataWrap< Average, ScalarInfoProxy >
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
 
Averagename (const std::string &name)
 Set the name and marks this stat to print at the end of simulation. More...
 
const std::string & name () const
 
AveragesetSeparator (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
 
Averageunit (const units::Base *_unit)
 Set the unit of the stat. More...
 
Averagedesc (const std::string &_desc)
 Set the description and marks this stat to print at the end of simulation. More...
 
Averageprecision (int _precision)
 Set the precision and marks this stat to print at the end of simulation. More...
 
Averageflags (Flags _flags)
 Set the flags and marks this stat to print at the end of simulation. More...
 
Averageprereq (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::ScalarBase< Average, AvgStor >
typedef AvgStor Storage
 
typedef AvgStor ::Params Params
 
- Public Types inherited from gem5::statistics::DataWrap< Average, ScalarInfoProxy >
typedef ScalarInfoProxy< AverageInfo
 
- Protected Member Functions inherited from gem5::statistics::ScalarBase< Average, AvgStor >
 GEM5_ALIGNED (8) char storage[sizeof(Storage)]
 The storage of 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< Average, ScalarInfoProxy >
Averageself ()
 
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

A stat that calculates the per tick average of a value.

See also
Stat, ScalarBase, AvgStor

Definition at line 1955 of file statistics.hh.

Constructor & Destructor Documentation

◆ Average() [1/3]

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

Definition at line 1960 of file statistics.hh.

◆ Average() [2/3]

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

Definition at line 1966 of file statistics.hh.

◆ Average() [3/3]

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

Definition at line 1972 of file statistics.hh.


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

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