stan::common::recorder::sum_values Class Reference

#include <sum_values.hpp>

Public Member Functions
	sum_values (const size_t N)
	sum_values (const size_t N, const size_t skip)
void	operator() (const std::vector< std::string > &x)
	Do nothing with std::string vector. More...
template<class T >
void	operator() (const std::vector< T > &x)
	Add values to cumulative sum. More...
void	operator() (const std::string x)
	Do nothing with a string. More...
void	operator() ()
	Do nothing. More...
bool	is_recording () const
	Indicator function for whether the instance is recording. More...
const std::vector< double > &	sum () const
const size_t	called () const
const size_t	recorded () const

Detailed Description

Definition at line 12 of file sum_values.hpp.

Constructor & Destructor Documentation

stan::common::recorder::sum_values::sum_values ( const size_t  N )

inline

Definition at line 14 of file sum_values.hpp.

stan::common::recorder::sum_values::sum_values ( const size_t  N, const size_t  skip  )

inline

Definition at line 17 of file sum_values.hpp.

Member Function Documentation

const size_t stan::common::recorder::sum_values::called ( ) const

inline

Definition at line 72 of file sum_values.hpp.

bool stan::common::recorder::sum_values::is_recording ( ) const

inline

Indicator function for whether the instance is recording.

Definition at line 64 of file sum_values.hpp.

void stan::common::recorder::sum_values::operator() ( const std::vector< std::string > &  x )

inline

Do nothing with std::string vector.

Template Parameters

T	type of element

Parameters

x	vector of type T

Definition at line 27 of file sum_values.hpp.

template<class T >

void stan::common::recorder::sum_values::operator() ( const std::vector< T > &  x )

inline

Add values to cumulative sum.

Template Parameters

T	type of element

Parameters

x	vector of type T

Definition at line 37 of file sum_values.hpp.

void stan::common::recorder::sum_values::operator() ( const std::string  x )

inline

Do nothing with a string.

Parameters

x	string to print with prefix in front

Definition at line 53 of file sum_values.hpp.

void stan::common::recorder::sum_values::operator() ( )

inline

Do nothing.

Definition at line 59 of file sum_values.hpp.

const size_t stan::common::recorder::sum_values::recorded ( ) const

inline

Definition at line 76 of file sum_values.hpp.

const std::vector<double>& stan::common::recorder::sum_values::sum ( ) const

inline

Definition at line 68 of file sum_values.hpp.

---

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

• src/stan/common/recorder/sum_values.hpp