Stats::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 (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 556 of file storage.hh.

Constructor & Destructor Documentation

SampleStor()

Stats::SampleStor::SampleStor ( Info *  info )

inline

Create and initialize this storage.

Definition at line 575 of file storage.hh.

Member Function Documentation

prepare()

void Stats::SampleStor::prepare ( Info *  info, DistData &  data  )

inline

Definition at line 607 of file storage.hh.

References data, Stats::Deviation, samples, squares, Stats::Info::storageParams, sum, and Stats::DistParams::type.

Referenced by TEST().

reset()

void Stats::SampleStor::reset ( Info *  info )

inline

Reset stat value to default.

Definition at line 622 of file storage.hh.

References samples, squares, and sum.

Referenced by TEST().

sample()

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

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

Definition at line 587 of file storage.hh.

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

Referenced by TEST().

size()

size_type Stats::SampleStor::size ( ) const

inline

Return the number of entries in this stat, 1.

Returns

1.

Definition at line 598 of file storage.hh.

Referenced by TEST().

zero()

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 604 of file storage.hh.

References samples.

Referenced by TEST().

Member Data Documentation

samples

Counter Stats::SampleStor::samples

private

The number of samples.

Definition at line 564 of file storage.hh.

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

squares

Counter Stats::SampleStor::squares

private

The sum of squares.

Definition at line 562 of file storage.hh.

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

sum

Counter Stats::SampleStor::sum

private

The current sum.

Definition at line 560 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