gem5  v20.1.0.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Stats::Vector2dBase< Derived, Stor > Class Template Reference

#include <statistics.hh>

Inheritance diagram for Stats::Vector2dBase< Derived, Stor >:
Stats::DataWrapVec2d< Derived, InfoProxyType > Stats::DataWrapVec< Derived, InfoProxyType > Stats::DataWrap< Derived, InfoProxyType > Stats::InfoAccess

Public Types

typedef Vector2dInfoProxy< Derived > Info
 
typedef Stor Storage
 
typedef Stor::Params Params
 
typedef VectorProxy< Derived > Proxy
 
- Public Types inherited from Stats::DataWrapVec2d< Derived, InfoProxyType >
typedef InfoProxyType< Derived > Info
 
- Public Types inherited from Stats::DataWrapVec< Derived, InfoProxyType >
typedef InfoProxyType< Derived > Info
 
- Public Types inherited from Stats::DataWrap< Derived, InfoProxyType >
typedef InfoProxyType< Derived > Info
 

Public Member Functions

 Vector2dBase (Group *parent, const char *name, const char *desc)
 
 ~Vector2dBase ()
 
Derived & init (size_type _x, size_type _y)
 
Proxy operator[] (off_type index)
 
size_type size () const
 
bool zero () const
 
Result total () const
 Return a total of all entries in this vector. More...
 
void prepare ()
 
void reset ()
 Reset stat value to default. More...
 
bool check () const
 
- Public Member Functions inherited from Stats::DataWrapVec2d< Derived, InfoProxyType >
 DataWrapVec2d (Group *parent, const char *name, const char *desc)
 
Derived & ysubnames (const char **names)
 
Derived & ysubname (off_type index, const std::string &subname)
 
std::string ysubname (off_type i) const
 
- Public Member Functions inherited from Stats::DataWrapVec< Derived, InfoProxyType >
 DataWrapVec (Group *parent=nullptr, const char *name=nullptr, const char *desc=nullptr)
 
Derived & subname (off_type index, const std::string &name)
 Set the subfield name for the given index, and marks this stat to print at the end of simulation. More...
 
Derived & subdesc (off_type index, const std::string &desc)
 Set the subfield description for the given index and marks this stat to print at the end of simulation. More...
 
void prepare ()
 
void reset ()
 
- Public Member Functions inherited from Stats::DataWrap< Derived, InfoProxyType >
const Infoinfo () const
 
 DataWrap ()=delete
 
 DataWrap (const DataWrap &)=delete
 
DataWrapoperator= (const DataWrap &)=delete
 
 DataWrap (Group *parent, const char *name, const char *desc)
 
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...
 
template<class Stat >
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

Storagedata (off_type index)
 
const Storagedata (off_type index) const
 
- Protected Member Functions inherited from Stats::DataWrap< Derived, InfoProxyType >
Derived & self ()
 
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...
 

Protected Attributes

size_type x
 
size_type y
 
size_type _size
 
Storagestorage
 

Friends

class ScalarProxy< Derived >
 
class VectorProxy< Derived >
 
class DataWrapVec< Derived, Vector2dInfoProxy >
 
class DataWrapVec2d< Derived, Vector2dInfoProxy >
 

Detailed Description

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

Definition at line 1274 of file statistics.hh.

Member Typedef Documentation

◆ Info

template<class Derived , class Stor >
typedef Vector2dInfoProxy<Derived> Stats::Vector2dBase< Derived, Stor >::Info

Definition at line 1277 of file statistics.hh.

◆ Params

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

Definition at line 1279 of file statistics.hh.

◆ Proxy

template<class Derived , class Stor >
typedef VectorProxy<Derived> Stats::Vector2dBase< Derived, Stor >::Proxy

Definition at line 1280 of file statistics.hh.

◆ Storage

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

Definition at line 1278 of file statistics.hh.

Constructor & Destructor Documentation

◆ Vector2dBase()

template<class Derived , class Stor >
Stats::Vector2dBase< Derived, Stor >::Vector2dBase ( Group parent,
const char *  name,
const char *  desc 
)
inline

Definition at line 1297 of file statistics.hh.

◆ ~Vector2dBase()

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

Definition at line 1302 of file statistics.hh.

Member Function Documentation

◆ check()

template<class Derived , class Stor >
bool Stats::Vector2dBase< Derived, Stor >::check ( ) const
inline

Definition at line 1399 of file statistics.hh.

◆ data() [1/2]

template<class Derived , class Stor >
Storage* Stats::Vector2dBase< Derived, Stor >::data ( off_type  index)
inlineprotected

◆ data() [2/2]

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

Definition at line 1294 of file statistics.hh.

◆ init()

template<class Derived , class Stor >
Derived& Stats::Vector2dBase< Derived, Stor >::init ( size_type  _x,
size_type  _y 
)
inline

◆ operator[]()

template<class Derived , class Stor >
Proxy Stats::Vector2dBase< Derived, Stor >::operator[] ( off_type  index)
inline

Definition at line 1339 of file statistics.hh.

◆ prepare()

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

Definition at line 1373 of file statistics.hh.

◆ reset()

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

Reset stat value to default.

Definition at line 1390 of file statistics.hh.

◆ size()

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

◆ total()

template<class Derived , class Stor >
Result Stats::Vector2dBase< Derived, Stor >::total ( ) const
inline

Return a total of all entries in this vector.

Returns
The total of all vector entries.

Definition at line 1364 of file statistics.hh.

Referenced by Stats::Vector2dBase< Vector2d, StatStor >::total().

◆ zero()

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

Definition at line 1354 of file statistics.hh.

Friends And Related Function Documentation

◆ DataWrapVec2d< Derived, Vector2dInfoProxy >

template<class Derived , class Stor >
friend class DataWrapVec2d< Derived, Vector2dInfoProxy >
friend

Definition at line 1284 of file statistics.hh.

◆ DataWrapVec< Derived, Vector2dInfoProxy >

template<class Derived , class Stor >
friend class DataWrapVec< Derived, Vector2dInfoProxy >
friend

Definition at line 1283 of file statistics.hh.

◆ ScalarProxy< Derived >

template<class Derived , class Stor >
friend class ScalarProxy< Derived >
friend

Definition at line 1281 of file statistics.hh.

◆ VectorProxy< Derived >

template<class Derived , class Stor >
friend class VectorProxy< Derived >
friend

Definition at line 1282 of file statistics.hh.

Member Data Documentation

◆ _size

template<class Derived , class Stor >
size_type Stats::Vector2dBase< Derived, Stor >::_size
protected

◆ storage

template<class Derived , class Stor >
Storage* Stats::Vector2dBase< Derived, Stor >::storage
protected

◆ x

template<class Derived , class Stor >
size_type Stats::Vector2dBase< Derived, Stor >::x
protected

Definition at line 1287 of file statistics.hh.

Referenced by Stats::Vector2dBase< Vector2d, StatStor >::init().

◆ y

template<class Derived , class Stor >
size_type Stats::Vector2dBase< Derived, Stor >::y
protected

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