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:

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.
void	operator++ (int)
	Increment the stat by 1.
void	operator-- ()
	Decrement the stat by 1.
void	operator-- (int)
	Decrement the stat by 1.
void	operator= (const U &v)
	Set the data value to the given value.
void	operator+= (const U &v)
	Increment the stat by the given value.
void	operator-= (const U &v)
	Decrement the stat by the given value.
size_type	size () const
	Return the number of elements, always 1 for a scalar.
Counter	value () const
	Return the current value of this stat as its base type.
Result	result () const
Result	total () const
bool	zero () const
void	reset ()
void	prepare ()
Public Member Functions inherited from gem5::statistics::DataWrap< Average, ScalarInfoProxy >
const Info *	info () const
	DataWrap ()=delete
	DataWrap (const DataWrap &)=delete
	DataWrap (Group *parent, const char *name, const units::Base *unit, 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.
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.
const std::string &	setSeparator () const
Average &	unit (const units::Base *_unit)
	Set the unit of the stat.
Average &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation.
Average &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation.
Average &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation.
Average &	prereq (const Stat &prereq)
	Set the prerequisite stat and marks this stat to print at the end of simulation.
Public Member Functions inherited from gem5::statistics::InfoAccess
	InfoAccess ()
void	reset ()
	Reset the stat to the default state.
bool	zero () const
bool	check () const
	Check that this stat has been set up properly and is ready for use.

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< Average >	Info
Protected Member Functions inherited from gem5::statistics::ScalarBase< Average, AvgStor >
	GEM5_ALIGNED (8) char storage[sizeof(Storage)]
	The storage of this stat.
Storage *	data ()
	Retrieve the storage.
const Storage *	data () const
	Retrieve a const pointer to the storage.
void	doInit ()
Protected Member Functions inherited from gem5::statistics::DataWrap< Average, ScalarInfoProxy >
Average &	self ()
Info *	info ()
Protected Member Functions inherited from gem5::statistics::InfoAccess
void	setInfo (Group *parent, Info *info)
	Set up an info class for this statistic.
void	setParams (const StorageParams *params)
	Save Storage class parameters if any.
void	setInit ()
	Save Storage class parameters if any.
Info *	info ()
	Grab the information class for this statistic.
const Info *	info () const
	Grab the information class for this statistic.
bool	newStyleStats () const
	Check if the info is new style stats.

Detailed Description

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

See also

Stat, ScalarBase, AvgStor

Definition at line 1957 of file statistics.hh.

Constructor & Destructor Documentation

Average() [1/3]

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

inline

Definition at line 1962 of file statistics.hh.

Average() [2/3]

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

inline

Definition at line 1968 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 1974 of file statistics.hh.

---

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

• base/statistics.hh