gem5  v20.1.0.0
Classes | Public Member Functions | Private Attributes | List of all members
Stats::SparseHistStor Class Reference

Templatized storage and interface for a sparse histogram stat. More...

#include <statistics.hh>

Classes

struct  Params
 The parameters for a sparse histogram stat. More...
 

Public Member Functions

 SparseHistStor (Info *info)
 
void sample (Counter val, int number)
 Add a value to the distribution for the given number of times. More...
 
size_type size () const
 Return the number of buckets in this distribution. More...
 
bool zero () const
 Returns true if any calls to sample have been made. More...
 
void prepare (Info *info, SparseHistData &data)
 
void reset (Info *info)
 Reset stat value to default. More...
 

Private Attributes

Counter samples
 Counter for number of samples. More...
 
MCounter cmap
 Counter for each bucket. More...
 

Detailed Description

Templatized storage and interface for a sparse histogram stat.

Definition at line 2935 of file statistics.hh.

Constructor & Destructor Documentation

◆ SparseHistStor()

Stats::SparseHistStor::SparseHistStor ( Info info)
inline

Definition at line 2951 of file statistics.hh.

References reset().

Member Function Documentation

◆ prepare()

void Stats::SparseHistStor::prepare ( Info info,
SparseHistData data 
)
inline

Definition at line 2985 of file statistics.hh.

References cmap, data, and samples.

◆ reset()

void Stats::SparseHistStor::reset ( Info info)
inline

Reset stat value to default.

Definition at line 3000 of file statistics.hh.

References cmap, and samples.

Referenced by SparseHistStor().

◆ sample()

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

Add a value to the distribution for the given number of times.

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

Definition at line 2962 of file statistics.hh.

References cmap, samples, and X86ISA::val.

◆ size()

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

Return the number of buckets in this distribution.

Returns
the number of buckets.

Definition at line 2972 of file statistics.hh.

References cmap.

◆ zero()

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

Returns true if any calls to sample have been made.

Returns
True if any values have been sampled.

Definition at line 2979 of file statistics.hh.

References samples.

Member Data Documentation

◆ cmap

MCounter Stats::SparseHistStor::cmap
private

Counter for each bucket.

Definition at line 2948 of file statistics.hh.

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

◆ samples

Counter Stats::SparseHistStor::samples
private

Counter for number of samples.

Definition at line 2946 of file statistics.hh.

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


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