Calculates the mean and variance of all the samples. More...
#include <statistics.hh>
Inheritance diagram for Stats::StandardDeviation:
Public Member Functions | |
| StandardDeviation (Group *parent=nullptr, const char *name=nullptr, const char *desc=nullptr) | |
| Construct and initialize this distribution. More... | |
 Public Member Functions inherited from Stats::DistBase< StandardDeviation, SampleStor > | |
| DistBase (Group *parent, const char *name, const char *desc) | |
| void | sample (const U &v, int n=1) |
| Add a value to the distribtion n times. More... | |
| size_type | size () const |
| Return the number of entries in this stat. More... | |
| bool | zero () const |
| Return true if no samples have been added. More... | |
| void | prepare () |
| void | reset () |
| Reset stat value to default. More... | |
| void | add (DistBase &d) |
| Add the argument distribution to the this distribution. More... | |
| Public Member Functions inherited from Stats::DataWrap< StandardDeviation, DistInfoProxy > | |
| const Info * | info () const |
| DataWrap ()=delete | |
| DataWrap (const DataWrap &)=delete | |
| DataWrap (Group *parent, const char *name, const char *desc) | |
| DataWrap & | operator= (const DataWrap &)=delete |
| StandardDeviation & | 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 |
| StandardDeviation & | 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 |
| StandardDeviation & | desc (const std::string &_desc) |
| Set the description and marks this stat to print at the end of simulation. More... | |
| StandardDeviation & | precision (int _precision) |
| Set the precision and marks this stat to print at the end of simulation. More... | |
| StandardDeviation & | flags (Flags _flags) |
| Set the flags and marks this stat to print at the end of simulation. More... | |
| StandardDeviation & | 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... | |
Additional Inherited Members | |
| Public Types inherited from Stats::DistBase< StandardDeviation, SampleStor > | |
| typedef DistInfoProxy< StandardDeviation > | Info |
| typedef SampleStor | Storage |
| typedef SampleStor ::Params | Params |
| Public Types inherited from Stats::DataWrap< StandardDeviation, DistInfoProxy > | |
| typedef DistInfoProxy< StandardDeviation > | Info |
| Protected Member Functions inherited from Stats::DistBase< StandardDeviation, SampleStor > | |
| char storage[sizeof(Storage)] | __attribute__ ((aligned(8))) |
| The storage for this stat. More... | |
| Storage * | data () |
| Retrieve the storage. More... | |
| const Storage * | data () const |
| Retrieve a const pointer to the storage. More... | |
| void | doInit () |
| Protected Member Functions inherited from Stats::DataWrap< StandardDeviation, DistInfoProxy > | |
| StandardDeviation & | self () |
| Info * | info () |
| 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... | |
| Info * | info () |
| Grab the information class for this statistic. More... | |
| const Info * | info () const |
| Grab the information class for this statistic. More... | |
Detailed Description
Calculates the mean and variance of all the samples.
- See also
- DistBase, SampleStor
Definition at line 2683 of file statistics.hh.
Constructor & Destructor Documentation
◆ StandardDeviation()
|
inline |
Construct and initialize this distribution.
Definition at line 2689 of file statistics.hh.
References Stats::DistBase< StandardDeviation, SampleStor >::doInit(), and Stats::InfoAccess::setParams().
The documentation for this class was generated from the following file:
- base/statistics.hh