Stats::VectorStandardDeviation Class Reference

This is a vector of StandardDeviation stats. More...

#include <statistics.hh>

Inheritance diagram for Stats::VectorStandardDeviation:

Public Member Functions
	VectorStandardDeviation (Group *parent=nullptr)
	VectorStandardDeviation (Group *parent, const char *name, const char *desc=nullptr)
	VectorStandardDeviation (Group *parent, const char *name, const Units::Base *unit, const char *desc=nullptr)
VectorStandardDeviation &	init (size_type size)
	Initialize storage for this distribution. More...
Public Member Functions inherited from Stats::VectorDistBase< VectorStandardDeviation, SampleStor >
	VectorDistBase (Group *parent, const char *name, const Units::Base *unit, const char *desc)
	~VectorDistBase ()
Proxy	operator[] (off_type index)
size_type	size () const
bool	zero () const
void	prepare ()
bool	check () const
Public Member Functions inherited from Stats::DataWrapVec< VectorStandardDeviation, VectorDistInfoProxy >
	DataWrapVec (Group *parent=nullptr, const char *name=nullptr, const Units::Base *unit=UNIT_UNSPECIFIED, const char *desc=nullptr)
VectorStandardDeviation &	subname (off_type index, const std::string &name)
	Set the subfield name for the given index, and marks this stat to print at the end of simulation. More...
VectorStandardDeviation &	subdesc (off_type index, const std::string &desc)
	Set the subfield description for the given index and marks this stat to print at the end of simulation. More...
void	prepare ()
void	reset ()
Public Member Functions inherited from Stats::DataWrap< VectorStandardDeviation, VectorDistInfoProxy >
const Info *	info () const
	DataWrap ()=delete
	DataWrap (const DataWrap &)=delete
	DataWrap (Group *parent, const char *name, const Units::Base *unit, const char *desc)
DataWrap &	operator= (const DataWrap &)=delete
VectorStandardDeviation &	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
VectorStandardDeviation &	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
VectorStandardDeviation &	unit (const Units::Base *_unit)
	Set the unit of the stat. More...
VectorStandardDeviation &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation. More...
VectorStandardDeviation &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation. More...
VectorStandardDeviation &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation. More...
VectorStandardDeviation &	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::VectorDistBase< VectorStandardDeviation, SampleStor >
typedef VectorDistInfoProxy< VectorStandardDeviation >	Info
typedef SampleStor	Storage
typedef SampleStor ::Params	Params
typedef DistProxy< VectorStandardDeviation >	Proxy
Public Types inherited from Stats::DataWrapVec< VectorStandardDeviation, VectorDistInfoProxy >
typedef VectorDistInfoProxy< VectorStandardDeviation >	Info
Public Types inherited from Stats::DataWrap< VectorStandardDeviation, VectorDistInfoProxy >
typedef VectorDistInfoProxy< VectorStandardDeviation >	Info
Protected Member Functions inherited from Stats::VectorDistBase< VectorStandardDeviation, SampleStor >
Storage *	data (off_type index)
const Storage *	data (off_type index) const
void	doInit (size_type s)
Protected Member Functions inherited from Stats::DataWrap< VectorStandardDeviation, VectorDistInfoProxy >
VectorStandardDeviation &	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...
Protected Attributes inherited from Stats::VectorDistBase< VectorStandardDeviation, SampleStor >
Storage *	storage
size_type	_size

Detailed Description

This is a vector of StandardDeviation stats.

See also

VectorDistBase, SampleStor

Definition at line 2290 of file statistics.hh.

Constructor & Destructor Documentation

VectorStandardDeviation() [1/3]

Stats::VectorStandardDeviation::VectorStandardDeviation ( Group *  parent = nullptr )

inline

Definition at line 2294 of file statistics.hh.

VectorStandardDeviation() [2/3]

Stats::VectorStandardDeviation::VectorStandardDeviation ( Group *  parent, const char *  name, const char *  desc = nullptr  )

inline

Definition at line 2300 of file statistics.hh.

VectorStandardDeviation() [3/3]

Stats::VectorStandardDeviation::VectorStandardDeviation ( Group *  parent, const char *  name, const Units::Base *  unit, const char *  desc = nullptr  )

inline

Definition at line 2307 of file statistics.hh.

Member Function Documentation

init()

VectorStandardDeviation& Stats::VectorStandardDeviation::init ( size_type  size )

inline

Initialize storage for this distribution.

Parameters

size	The size of the vector.

Returns

A reference to this distribution.

Definition at line 2321 of file statistics.hh.

References Stats::VectorDistBase< VectorStandardDeviation, SampleStor >::doInit(), and Stats::InfoAccess::setParams().

---

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

• base/statistics.hh