A vector of scalar stats. More...

#include <statistics.hh>

Inheritance diagram for Stats::Vector:

Public Member Functions
	Vector (Group *parent=nullptr)

	Vector (Group parent, const char name, const char *desc=nullptr)

	Vector (Group parent, const char name, const Units::Base unit, const char desc=nullptr)

Public Member Functions inherited from Stats::VectorBase< Vector, StatStor >
void	value (VCounter &vec) const

void	result (VResult &vec) const
	Copy the values to a local vector and return a reference to it. More...

Result	total () const
	Return a total of all entries in this vector. More...

size_type	size () const

bool	zero () const

bool	check () const

	VectorBase (Group parent, const char name, const Units::Base unit, const char desc)

	~VectorBase ()

Vector &	init (size_type size)
	Set this vector to have the given size. More...

Proxy	operator[] (off_type index)
	Return a reference (ScalarProxy) to the stat at the given index. More...

Public Member Functions inherited from Stats::DataWrapVec< Vector, VectorInfoProxy >
	DataWrapVec (Group parent=nullptr, const char name=nullptr, const Units::Base unit=UNIT_UNSPECIFIED, const char desc=nullptr)

Vector &	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...

Vector &	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< Vector, VectorInfoProxy >
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

Vector &	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

Vector &	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

Vector &	unit (const Units::Base *_unit)
	Set the unit of the stat. More...

Vector &	desc (const std::string &_desc)
	Set the description and marks this stat to print at the end of simulation. More...

Vector &	precision (int _precision)
	Set the precision and marks this stat to print at the end of simulation. More...

Vector &	flags (Flags _flags)
	Set the flags and marks this stat to print at the end of simulation. More...

Vector &	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::VectorBase< Vector, StatStor >
typedef StatStor	Storage

typedef StatStor ::Params	Params

typedef ScalarProxy< Vector >	Proxy
	Proxy type. More...

Public Types inherited from Stats::DataWrapVec< Vector, VectorInfoProxy >
typedef VectorInfoProxy< Vector >	Info

Public Types inherited from Stats::DataWrap< Vector, VectorInfoProxy >
typedef VectorInfoProxy< Vector >	Info

Protected Member Functions inherited from Stats::VectorBase< Vector, StatStor >
Storage *	data (off_type index)
	Retrieve the storage. More...

const Storage *	data (off_type index) const
	Retrieve a const pointer to the storage. More...

void	doInit (size_type s)

Protected Member Functions inherited from Stats::DataWrap< Vector, VectorInfoProxy >
Vector &	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::VectorBase< Vector, StatStor >
Storage *	storage
	The storage of this stat. More...

size_type	_size

Detailed Description

A vector of scalar stats.

See also: Stat, VectorBase, StatStor

Definition at line 2007 of file statistics.hh.

Constructor & Destructor Documentation

◆ Vector() [1/3]

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

inline

Definition at line 2010 of file statistics.hh.

◆ Vector() [2/3]

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

inline

Definition at line 2016 of file statistics.hh.

◆ Vector() [3/3]

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

inline

Definition at line 2021 of file statistics.hh.

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

base/statistics.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Vector() [1/3]

◆ Vector() [2/3]

◆ Vector() [3/3]