gem5::statistics::SparseHistogram Class Reference

#include <statistics.hh>

Inheritance diagram for gem5::statistics::SparseHistogram:

Public Member Functions
	SparseHistogram (Group *parent=nullptr)
	SparseHistogram (Group *parent, const char *name, const char *desc=nullptr)
	SparseHistogram (Group *parent, const char *name, const units::Base *unit, const char *desc=nullptr)
SparseHistogram &	init (size_type size)
	Set the parameters of this histogram.
Public Member Functions inherited from gem5::statistics::SparseHistBase< SparseHistogram, SparseHistStor >
	SparseHistBase (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.
size_type	size () const
	Return the number of entries in this stat.
bool	zero () const
	Return true if no samples have been added.
void	prepare ()
void	reset ()
	Reset stat value to default.
Public Member Functions inherited from gem5::statistics::DataWrap< SparseHistogram, SparseHistInfoProxy >
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
SparseHistogram &	name (const std::string &name)
	Set the name and marks this stat to print at the end of simulation.
const std::string &	name () const
SparseHistogram &	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
SparseHistogram &	unit (const units::Base *_unit)
	Set the unit of the stat.
SparseHistogram &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation.
SparseHistogram &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation.
SparseHistogram &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation.
SparseHistogram &	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::SparseHistBase< SparseHistogram, SparseHistStor >
typedef SparseHistInfoProxy< SparseHistogram >	Info
typedef SparseHistStor	Storage
typedef SparseHistStor::Params	Params
Public Types inherited from gem5::statistics::DataWrap< SparseHistogram, SparseHistInfoProxy >
typedef SparseHistInfoProxy< SparseHistogram >	Info
Protected Member Functions inherited from gem5::statistics::SparseHistBase< SparseHistogram, SparseHistStor >
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< SparseHistogram, SparseHistInfoProxy >
SparseHistogram &	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.
Protected Attributes inherited from gem5::statistics::SparseHistBase< SparseHistogram, SparseHistStor >
char	storage [sizeof(Storage)]
	The storage for this stat.

Detailed Description

Definition at line 2494 of file statistics.hh.

Constructor & Destructor Documentation

SparseHistogram() [1/3]

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

inline

Definition at line 2497 of file statistics.hh.

SparseHistogram() [2/3]

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

inline

Definition at line 2503 of file statistics.hh.

SparseHistogram() [3/3]

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

inline

Definition at line 2510 of file statistics.hh.

Member Function Documentation

init()

SparseHistogram & gem5::statistics::SparseHistogram::init ( size_type size )

inline

Set the parameters of this histogram.

See also

HistStor::Params

Parameters

size	The number of buckets in the histogram

Returns

A reference to this histogram.

Definition at line 2523 of file statistics.hh.

References gem5::statistics::SparseHistBase< SparseHistogram, SparseHistStor >::doInit(), gem5::statistics::DataWrap< SparseHistogram, SparseHistInfoProxy >::self(), and gem5::statistics::InfoAccess::setParams().

Referenced by gem5::CommMonitor::MonitorStats::MonitorStats(), gem5::SparseHistStatTester::SparseHistStatTesterStats::SparseHistStatTesterStats(), and gem5::StackDistProbe::StackDistProbeStats::StackDistProbeStats().

---

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

• base/statistics.hh