gem5::statistics::SampleStor Class Reference

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

#include <storage.hh>

Classes
struct	Params

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

Private Attributes
Counter	sum
	The current sum.
Counter	squares
	The sum of squares.
Counter	samples
	The number of samples.

Detailed Description

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

Definition at line 559 of file storage.hh.

Constructor & Destructor Documentation

SampleStor()

gem5::statistics::SampleStor::SampleStor ( const StorageParams *const storage_params )

inline

Create and initialize this storage.

Definition at line 578 of file storage.hh.

Member Function Documentation

prepare()

void gem5::statistics::SampleStor::prepare ( const StorageParams *const storage_params, DistData & data )

inline

Definition at line 610 of file storage.hh.

References data, gem5::statistics::Deviation, gem5::safe_cast(), samples, squares, sum, and gem5::statistics::DistParams::type.

Referenced by TEST(), and TEST().

reset()

void gem5::statistics::SampleStor::reset ( const StorageParams *const storage_params )

inline

Reset stat value to default.

Definition at line 625 of file storage.hh.

References samples, squares, and sum.

Referenced by TEST(), TEST(), and TEST().

sample()

void gem5::statistics::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

val	The value to add.
number	The number of times to add the value.

Definition at line 590 of file storage.hh.

References samples, squares, sum, and gem5::X86ISA::val.

Referenced by TEST(), TEST(), and TEST().

size()

size_type gem5::statistics::SampleStor::size ( ) const

inline

Return the number of entries in this stat, 1.

Returns

1.

Definition at line 601 of file storage.hh.

Referenced by TEST().

zero()

bool gem5::statistics::SampleStor::zero ( ) const

inline

Return true if no samples have been added.

Returns

True if no samples have been added.

Definition at line 607 of file storage.hh.

References samples.

Referenced by TEST(), and TEST().

Member Data Documentation

samples

Counter gem5::statistics::SampleStor::samples

private

The number of samples.

Definition at line 567 of file storage.hh.

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

squares

Counter gem5::statistics::SampleStor::squares

private

The sum of squares.

Definition at line 565 of file storage.hh.

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

sum

Counter gem5::statistics::SampleStor::sum

private

The current sum.

Definition at line 563 of file storage.hh.

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

---

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

• base/stats/storage.hh