Implementation of a sparse histogram stat. More...
#include <statistics.hh>
Public Types | |
| typedef SparseHistInfoProxy< Derived > | Info |
| typedef Stor | Storage |
| typedef Stor::Params | Params |
 Public Types inherited from Stats::DataWrap< Derived, SparseHistInfoProxy > | |
| typedef SparseHistInfoProxy< Derived > | Info |
Public Member Functions | |
| SparseHistBase (Group *parent, const char *name, const char *desc) | |
| template<typename U > | |
| 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... | |
| Public Member Functions inherited from Stats::DataWrap< Derived, SparseHistInfoProxy > | |
| const Info * | info () const |
| DataWrap ()=delete | |
| DataWrap (const DataWrap &)=delete | |
| DataWrap (Group *parent, const char *name, const char *desc) | |
| DataWrap & | operator= (const DataWrap &)=delete |
| Derived & | 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 |
| Derived & | 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 |
| Derived & | desc (const std::string &_desc) |
| Set the description and marks this stat to print at the end of simulation. More... | |
| Derived & | precision (int _precision) |
| Set the precision and marks this stat to print at the end of simulation. More... | |
| Derived & | flags (Flags _flags) |
| Set the flags and marks this stat to print at the end of simulation. More... | |
| Derived & | 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... | |
Protected Member Functions | |
| 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< Derived, SparseHistInfoProxy > | |
| Derived & | 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... | |
Protected Attributes | |
| char | storage [sizeof(Storage)] |
| The storage for this stat. More... | |
Detailed Description
template<class Derived, class Stor>
class Stats::SparseHistBase< Derived, Stor >
Implementation of a sparse histogram stat.
The storage class is determined by the Storage template.
Definition at line 2850 of file statistics.hh.
Member Typedef Documentation
◆ Info
| typedef SparseHistInfoProxy<Derived> Stats::SparseHistBase< Derived, Stor >::Info |
Definition at line 2853 of file statistics.hh.
◆ Params
| typedef Stor::Params Stats::SparseHistBase< Derived, Stor >::Params |
Definition at line 2855 of file statistics.hh.
◆ Storage
| typedef Stor Stats::SparseHistBase< Derived, Stor >::Storage |
Definition at line 2854 of file statistics.hh.
Constructor & Destructor Documentation
◆ SparseHistBase()
|
inline |
Definition at line 2890 of file statistics.hh.
Member Function Documentation
◆ data() [1/2]
|
inlineprotected |
Retrieve the storage.
- Returns
- The storage object for this stat.
Definition at line 2867 of file statistics.hh.
Referenced by Stats::SparseHistBase< SparseHistogram, SparseHistStor >::prepare(), Stats::SparseHistBase< SparseHistogram, SparseHistStor >::reset(), Stats::SparseHistBase< SparseHistogram, SparseHistStor >::sample(), Stats::SparseHistBase< SparseHistogram, SparseHistStor >::size(), and Stats::SparseHistBase< SparseHistogram, SparseHistStor >::zero().
◆ data() [2/2]
|
inlineprotected |
Retrieve a const pointer to the storage.
- Returns
- A const pointer to the storage object for this stat.
Definition at line 2877 of file statistics.hh.
◆ doInit()
|
inlineprotected |
Definition at line 2883 of file statistics.hh.
◆ prepare()
|
inline |
Definition at line 2916 of file statistics.hh.
◆ reset()
|
inline |
Reset stat value to default.
Definition at line 2926 of file statistics.hh.
◆ sample()
|
inline |
Add a value to the distribtion n times.
Calls sample on the storage class.
- Parameters
-
v The value to add. n The number of times to add it, defaults to 1.
Definition at line 2902 of file statistics.hh.
Referenced by StackDistProbe::handleRequest(), and CommMonitor::MonitorStats::updateReqStats().
◆ size()
|
inline |
Return the number of entries in this stat.
- Returns
- The number of entries.
Definition at line 2908 of file statistics.hh.
◆ zero()
|
inline |
Return true if no samples have been added.
- Returns
- True if there haven't been any samples.
Definition at line 2913 of file statistics.hh.
Member Data Documentation
◆ storage
|
protected |
The storage for this stat.
Definition at line 2859 of file statistics.hh.
Referenced by Stats::SparseHistBase< SparseHistogram, SparseHistStor >::data(), and Stats::SparseHistBase< SparseHistogram, SparseHistStor >::doInit().
The documentation for this class was generated from the following file:
- base/statistics.hh