Class simtix::stat::Scalar

template <typename T>

ClassList > simtix > stat > Scalar

Inherits the following classes: simtix::stat::ScalarBase

Public Types

Type	Name
typedef T	Storage

Public Functions

Type	Name
	Scalar (Group * parent, const std::string & name, const std::string & desc, const std::string & unit)
virtual toml::table	Tabularize () override const Cannot be called.
virtual	operator double () override const
virtual	operator int64_t () override const
Storage	operator++ ()
Storage	operator++ (int)
void	operator+= (const Storage & s)
Storage	operator-- ()
Storage	operator-- (int)
void	operator-= (const Storage & s)
void	operator= (const Storage & s)

Public Functions inherited from simtix::stat::ScalarBase

See simtix::stat::ScalarBase

Type	Name
	ScalarBase (double constant) Implicit conversion from double makes this ScalarBase become a constant. cppcheck-suppress noExplicitConstructor.
	ScalarBase (Group * parent, const std::string & name, const std::string & desc, const std::string & unit)
bool	is_constant () const
	operator PostfixExpr () const
virtual	operator double () const
virtual	operator int64_t () const
PostfixExpr	operator* (const ScalarBase & rhs)
PostfixExpr	operator* (const PostfixExpr & rhs)
PostfixExpr	operator+ (const ScalarBase & rhs) Operations to produce a expr (s <op> s)
PostfixExpr	operator+ (const PostfixExpr & rhs) Operations to produce a expr (s <op> f)
PostfixExpr	operator- (const ScalarBase & rhs)
PostfixExpr	operator- (const PostfixExpr & rhs)
PostfixExpr	operator/ (const ScalarBase & rhs)
PostfixExpr	operator/ (const PostfixExpr & rhs)

Public Functions inherited from simtix::stat::StatBase

See simtix::stat::StatBase

Type	Name
	StatBase (Group * parent, const std::string & name, const std::string & desc, const std::string & unit) Register itself to the parent if any exist.
virtual toml::table	Tabularize () const = 0
const std::string &	desc () const
const std::string &	name () const
const std::string &	unit () const

Protected Attributes

Type	Name
Storage	storage_

Protected Attributes inherited from simtix::stat::StatBase

See simtix::stat::StatBase

Type	Name
std::string	desc_
std::string	name_
Group *	parent_
std::string	unit_

Public Types Documentation

typedef Storage

using simtix::stat::Scalar< T >::Storage =  T;

---

Public Functions Documentation

function Scalar

inline explicit simtix::stat::Scalar::Scalar (
    Group * parent,
    const std::string & name,
    const std::string & desc,
    const std::string & unit
) 

---

function Tabularize

Cannot be called.

inline virtual toml::table simtix::stat::Scalar::Tabularize () override const

Implements simtix::stat::ScalarBase::Tabularize

---

function operator double

inline explicit virtual simtix::stat::Scalar::operator double () override const

Implements simtix::stat::ScalarBase::operator double

---

function operator int64_t

inline explicit virtual simtix::stat::Scalar::operator int64_t () override const

Implements simtix::stat::ScalarBase::operator int64_t

---

function operator++

inline Storage simtix::stat::Scalar::operator++ () 

---

function operator++

inline Storage simtix::stat::Scalar::operator++ (
    int
) 

---

function operator+=

inline void simtix::stat::Scalar::operator+= (
    const Storage & s
) 

---

function operator--

inline Storage simtix::stat::Scalar::operator-- () 

---

function operator--

inline Storage simtix::stat::Scalar::operator-- (
    int
) 

---

function operator-=

inline void simtix::stat::Scalar::operator-= (
    const Storage & s
) 

---

function operator=

inline void simtix::stat::Scalar::operator= (
    const Storage & s
) 

---

Protected Attributes Documentation

variable storage_

Storage simtix::stat::Scalar< T >::storage_;

---

---

The documentation for this class was generated from the following file projects/simtix/include/simtix/statistics.h