A stat that calculates the per tick average of a value. More...
#include <statistics.hh>
Inheritance diagram for Stats::Average:
Public Member Functions | |
| Average (Group *parent=nullptr, const char *name=nullptr, const char *desc=nullptr) | |
 Public Member Functions inherited from Stats::ScalarBase< Average, AvgStor > | |
| Counter | value () const |
| Return the current value of this stat as its base type. More... | |
| Counter | value () |
| ScalarBase (Group *parent=nullptr, const char *name=nullptr, 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... | |
| Result | result () |
| Result | total () |
| bool | zero () |
| void | reset () |
| void | prepare () |
| Public Member Functions inherited from Stats::DataWrap< Average, ScalarInfoProxy > | |
| const Info * | info () const |
| DataWrap ()=delete | |
| DataWrap (const DataWrap &)=delete | |
| DataWrap (Group *parent, const char *name, const char *desc) | |
| DataWrap & | operator= (const DataWrap &)=delete |
| Average & | name (const std::string &name) |
| Set the name and marks this stat to print at the end of simulation. More... | |
| const std::string & | name () const |
| Average & | setSeparator (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 |
| Average & | desc (const std::string &_desc) |
| Set the description and marks this stat to print at the end of simulation. More... | |
| Average & | precision (int _precision) |
| Set the precision and marks this stat to print at the end of simulation. More... | |
| Average & | flags (Flags _flags) |
| Set the flags and marks this stat to print at the end of simulation. More... | |
| Average & | prereq (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 | |
| 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::ScalarBase< Average, AvgStor > | |
| typedef AvgStor | Storage |
| typedef AvgStor ::Params | Params |
| Public Types inherited from Stats::DataWrap< Average, ScalarInfoProxy > | |
| typedef ScalarInfoProxy< Average > | Info |
| Protected Member Functions inherited from Stats::ScalarBase< Average, AvgStor > | |
| char storage[sizeof(Storage)] | __attribute__ ((aligned(8))) |
| The storage of this stat. More... | |
| Storage * | data () |
| Retrieve the storage. More... | |
| const Storage * | data () const |
| Retrieve a const pointer to the storage. More... | |
| void | doInit () |
| Protected Member Functions inherited from Stats::DataWrap< Average, ScalarInfoProxy > | |
| Average & | self () |
| Info * | info () |
| Protected Member Functions inherited from Stats::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... | |
| Info * | info () |
| Grab the information class for this statistic. More... | |
| const Info * | info () 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 2549 of file statistics.hh.
Constructor & Destructor Documentation
◆ Average()
|
inline |
Definition at line 2554 of file statistics.hh.
The documentation for this class was generated from the following file:
- base/statistics.hh