Skip to content

Class simtix::stat::Vector

template <typename T>

ClassList > simtix > stat > Vector

Inherits the following classes: simtix::stat::StatBase

Public Types

Type Name
typedef typename T::Storage Storage

Public Functions

Type Name
virtual toml::table Tabularize () override const
Vector (Group * parent, const std::string & name, const std::string & desc, const std::string & unit, uint64_t size)
ScalarBase & average ()
std::vector< Storage > & data ()
const std::vector< Storage > & data () const
Storage & operator[] (uint64_t index)
ScalarBase & sum ()

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
simtix::stat::Vector::Average average_
std::vector< Storage > storage_
simtix::stat::Vector::Sum sum_

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::Vector< T >::Storage =  typename T::Storage;

Public Functions Documentation

function Tabularize

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

Implements simtix::stat::StatBase::Tabularize

function Vector

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

function average

inline ScalarBase & simtix::stat::Vector::average ()

function data [1/2]

inline std::vector< Storage > & simtix::stat::Vector::data ()

function data [2/2]

inline const std::vector< Storage > & simtix::stat::Vector::data () const

function operator[]

inline Storage & simtix::stat::Vector::operator[] (
    uint64_t index
)

function sum

inline ScalarBase & simtix::stat::Vector::sum ()

Protected Attributes Documentation

variable average_

simtix::stat::Vector::Average simtix::stat::Vector< T >::average_;

variable storage_

std::vector<Storage> simtix::stat::Vector< T >::storage_;

variable sum_

simtix::stat::Vector::Sum simtix::stat::Vector< T >::sum_;

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