gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Stats::SparseHistBase< Derived, Stor > Class Template Reference

Implementation of a sparse histogram stat. More...

#include <statistics.hh>

Inheritance diagram for Stats::SparseHistBase< Derived, Stor >:
Stats::DataWrap< Derived, SparseHistInfoProxy > Stats::InfoAccess

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 ()
 
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 Infoinfo () const
 
 DataWrap ()
 
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
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

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< Derived, SparseHistInfoProxy >
Derived & self ()
 
Infoinfo ()
 
 DataWrap (const DataWrap &stat)
 Copy constructor, copies are not allowed. More...
 
void operator= (const DataWrap &)
 Can't copy stats. More...
 
- Protected Member Functions inherited from Stats::InfoAccess
void setInfo (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...
 

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 2717 of file statistics.hh.

Member Typedef Documentation

template<class Derived, class Stor>
typedef SparseHistInfoProxy<Derived> Stats::SparseHistBase< Derived, Stor >::Info

Definition at line 2720 of file statistics.hh.

template<class Derived, class Stor>
typedef Stor::Params Stats::SparseHistBase< Derived, Stor >::Params

Definition at line 2722 of file statistics.hh.

template<class Derived, class Stor>
typedef Stor Stats::SparseHistBase< Derived, Stor >::Storage

Definition at line 2721 of file statistics.hh.

Constructor & Destructor Documentation

template<class Derived, class Stor>
Stats::SparseHistBase< Derived, Stor >::SparseHistBase ( )
inline

Definition at line 2757 of file statistics.hh.

Member Function Documentation

template<class Derived, class Stor>
Storage* Stats::SparseHistBase< Derived, Stor >::data ( )
inlineprotected
template<class Derived, class Stor>
const Storage* Stats::SparseHistBase< Derived, Stor >::data ( ) const
inlineprotected

Retrieve a const pointer to the storage.

Returns
A const pointer to the storage object for this stat.

Definition at line 2744 of file statistics.hh.

template<class Derived, class Stor>
void Stats::SparseHistBase< Derived, Stor >::doInit ( )
inlineprotected

Definition at line 2750 of file statistics.hh.

template<class Derived, class Stor>
void Stats::SparseHistBase< Derived, Stor >::prepare ( )
inline

Definition at line 2780 of file statistics.hh.

template<class Derived, class Stor>
void Stats::SparseHistBase< Derived, Stor >::reset ( )
inline

Reset stat value to default.

Definition at line 2790 of file statistics.hh.

template<class Derived, class Stor>
template<typename U >
void Stats::SparseHistBase< Derived, Stor >::sample ( const U &  v,
int  n = 1 
)
inline

Add a value to the distribtion n times.

Calls sample on the storage class.

Parameters
vThe value to add.
nThe number of times to add it, defaults to 1.

Definition at line 2766 of file statistics.hh.

Referenced by StackDistProbe::handleRequest(), and CommMonitor::MonitorStats::updateReqStats().

template<class Derived, class Stor>
size_type Stats::SparseHistBase< Derived, Stor >::size ( ) const
inline

Return the number of entries in this stat.

Returns
The number of entries.

Definition at line 2772 of file statistics.hh.

template<class Derived, class Stor>
bool Stats::SparseHistBase< Derived, Stor >::zero ( ) const
inline

Return true if no samples have been added.

Returns
True if there haven't been any samples.

Definition at line 2777 of file statistics.hh.

Member Data Documentation

template<class Derived, class Stor>
char Stats::SparseHistBase< Derived, Stor >::storage[sizeof(Storage)]
protected

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

Generated on Fri Jun 9 2017 13:04:40 for gem5 by doxygen 1.8.6