gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Private Attributes | List of all members
Stats::SampleStor Class Reference

Templatized storage and interface for a distribution that calculates mean and variance. More...

#include <statistics.hh>

Classes

struct  Params
 

Public Member Functions

 SampleStor (Info *info)
 Create and initialize this storage. More...
 
void sample (Counter val, int number)
 Add a value the given number of times to this running average. More...
 
size_type size () const
 Return the number of entries in this stat, 1. More...
 
bool zero () const
 Return true if no samples have been added. More...
 
void prepare (Info *info, DistData &data)
 
void reset (Info *info)
 Reset stat value to default. More...
 

Private Attributes

Counter sum
 The current sum. More...
 
Counter squares
 The sum of squares. More...
 
Counter samples
 The number of samples. More...
 

Detailed Description

Templatized storage and interface for a distribution that calculates mean and variance.

Definition at line 1664 of file statistics.hh.

Constructor & Destructor Documentation

Stats::SampleStor::SampleStor ( Info info)
inline

Create and initialize this storage.

Definition at line 1684 of file statistics.hh.

Member Function Documentation

void Stats::SampleStor::prepare ( Info info,
DistData data 
)
inline
void Stats::SampleStor::reset ( Info info)
inline

Reset stat value to default.

Definition at line 1732 of file statistics.hh.

References samples, squares, and sum.

void Stats::SampleStor::sample ( Counter  val,
int  number 
)
inline

Add a value the given number of times to this running average.

Update the running sum and sum of squares, increment the number of values seen by the given number.

Parameters
valThe value to add.
numberThe number of times to add the value.

Definition at line 1696 of file statistics.hh.

References samples, squares, and sum.

size_type Stats::SampleStor::size ( ) const
inline

Return the number of entries in this stat, 1.

Returns
1.

Definition at line 1708 of file statistics.hh.

bool Stats::SampleStor::zero ( ) const
inline

Return true if no samples have been added.

Returns
True if no samples have been added.

Definition at line 1714 of file statistics.hh.

References samples.

Member Data Documentation

Counter Stats::SampleStor::samples
private

The number of samples.

Definition at line 1678 of file statistics.hh.

Referenced by prepare(), reset(), sample(), and zero().

Counter Stats::SampleStor::squares
private

The sum of squares.

Definition at line 1676 of file statistics.hh.

Referenced by prepare(), reset(), and sample().

Counter Stats::SampleStor::sum
private

The current sum.

Definition at line 1674 of file statistics.hh.

Referenced by prepare(), reset(), and sample().


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