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

Implementation of a distribution stat. More...

#include <statistics.hh>

Inheritance diagram for Stats::DistBase< Derived, Stor >:
Stats::DataWrap< Derived, DistInfoProxy > Stats::InfoAccess

Public Types

typedef DistInfoProxy< Derived > Info
 
typedef Stor Storage
 
typedef Stor::Params Params
 
- Public Types inherited from Stats::DataWrap< Derived, DistInfoProxy >
typedef DistInfoProxy< Derived > Info
 

Public Member Functions

 DistBase ()
 
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...
 
void add (DistBase &d)
 Add the argument distribution to the this distribution. More...
 
- Public Member Functions inherited from Stats::DataWrap< Derived, DistInfoProxy >
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

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< Derived, DistInfoProxy >
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...
 

Detailed Description

template<class Derived, class Stor>
class Stats::DistBase< Derived, Stor >

Implementation of a distribution stat.

The type of distribution is determined by the Storage template.

See Also
ScalarBase

Definition at line 1820 of file statistics.hh.

Member Typedef Documentation

template<class Derived, class Stor>
typedef DistInfoProxy<Derived> Stats::DistBase< Derived, Stor >::Info

Definition at line 1823 of file statistics.hh.

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

Definition at line 1825 of file statistics.hh.

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

Definition at line 1824 of file statistics.hh.

Constructor & Destructor Documentation

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

Definition at line 1860 of file statistics.hh.

Member Function Documentation

template<class Derived, class Stor>
char storage [sizeof(Storage)] Stats::DistBase< Derived, Stor >::__attribute__ ( (aligned(8))  )
protected

The storage for this stat.

template<class Derived, class Stor>
void Stats::DistBase< Derived, Stor >::add ( DistBase< Derived, Stor > &  d)
inline

Add the argument distribution to the this distribution.

Definition at line 1901 of file statistics.hh.

Referenced by Profiler::collateStats().

template<class Derived, class Stor>
Storage* Stats::DistBase< Derived, Stor >::data ( )
inlineprotected
template<class Derived, class Stor>
const Storage* Stats::DistBase< 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 1847 of file statistics.hh.

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

Definition at line 1853 of file statistics.hh.

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

Definition at line 1883 of file statistics.hh.

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

Reset stat value to default.

Definition at line 1893 of file statistics.hh.

Referenced by Sequencer::resetStats(), AbstractController::resetStats(), and GPUCoalescer::resetStats().

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

Return the number of entries in this stat.

Returns
The number of entries.

Definition at line 1875 of file statistics.hh.

template<class Derived, class Stor>
bool Stats::DistBase< 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 1880 of file statistics.hh.


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

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