gem5  v20.1.0.0
Public Member Functions | List of all members
Stats::Distribution Class Reference

A simple distribution stat. More...

#include <statistics.hh>

Inheritance diagram for Stats::Distribution:
Stats::DistBase< Distribution, DistStor > Stats::DataWrap< Distribution, DistInfoProxy > Stats::InfoAccess

Public Member Functions

 Distribution (Group *parent=nullptr, const char *name=nullptr, const char *desc=nullptr)
 
Distributioninit (Counter min, Counter max, Counter bkt)
 Set the parameters of this distribution. More...
 
- Public Member Functions inherited from Stats::DistBase< Distribution, DistStor >
 DistBase (Group *parent, const char *name, 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 Stats::DataWrap< Distribution, DistInfoProxy >
const Infoinfo () const
 
 DataWrap ()=delete
 
 DataWrap (const DataWrap &)=delete
 
 DataWrap (Group *parent, const char *name, const char *desc)
 
DataWrapoperator= (const DataWrap &)=delete
 
Distributionname (const std::string &name)
 Set the name and marks this stat to print at the end of simulation. More...
 
const std::string & name () const
 
DistributionsetSeparator (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
 
Distributiondesc (const std::string &_desc)
 Set the description and marks this stat to print at the end of simulation. More...
 
Distributionprecision (int _precision)
 Set the precision and marks this stat to print at the end of simulation. More...
 
Distributionflags (Flags _flags)
 Set the flags and marks this stat to print at the end of simulation. More...
 
Distributionprereq (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::DistBase< Distribution, DistStor >
typedef DistInfoProxy< DistributionInfo
 
typedef DistStor Storage
 
typedef DistStor ::Params Params
 
- Public Types inherited from Stats::DataWrap< Distribution, DistInfoProxy >
typedef DistInfoProxy< DistributionInfo
 
- Protected Member Functions inherited from Stats::DistBase< Distribution, DistStor >
char storage[sizeof(Storage)] __attribute__ ((aligned(8)))
 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 Stats::DataWrap< Distribution, DistInfoProxy >
Distributionself ()
 
Infoinfo ()
 
- 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...
 
Infoinfo ()
 Grab the information class for this statistic. More...
 
const Infoinfo () const
 Grab the information class for this statistic. More...
 

Detailed Description

A simple distribution stat.

See also
Stat, DistBase, DistStor

Definition at line 2617 of file statistics.hh.

Constructor & Destructor Documentation

◆ Distribution()

Stats::Distribution::Distribution ( Group parent = nullptr,
const char *  name = nullptr,
const char *  desc = nullptr 
)
inline

Definition at line 2620 of file statistics.hh.

Member Function Documentation

◆ init()

Distribution& Stats::Distribution::init ( Counter  min,
Counter  max,
Counter  bkt 
)
inline

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

Generated on Wed Sep 30 2020 14:03:12 for gem5 by doxygen 1.8.17