alps::alea::mean_result< T > Class Template Reference

#include <joined.hpp>

Collaboration diagram for alps::alea::mean_result< T >:

Public Member Functions
	mean_result ()
	mean_result (const mean_data< T > &acc_data)
	mean_result (const mean_result &other)
mean_result &	operator= (const mean_result &other)
bool	valid () const
size_t	size () const
size_t	count () const
const column< T > &	mean () const
const mean_data< T > &	store () const
mean_data< T > &	store ()
void	reduce (const reducer &r)

Protected Member Functions
void	reduce (const reducer &, bool do_pre_commit, bool do_post_commit)

Friends
class	mean_acc< T >
void	serialize (serializer &, const std::string &, const mean_result &)
void	deserialize (deserializer &, const std::string &, mean_result &)
std::ostream &	operator<< (std::ostream &, const mean_result &)

Detailed Description

template<typename T>
class alps::alea::mean_result< T >

Result of a mean accumulation

Definition at line 13 of file joined.hpp.

Constructor & Destructor Documentation

template<typename T>

alps::alea::mean_result< T >::mean_result ( )

inline

Definition at line 167 of file mean.hpp.

template<typename T>

alps::alea::mean_result< T >::mean_result ( const mean_data< T > &  acc_data )

inline

Definition at line 169 of file mean.hpp.

template<typename T >

alps::alea::mean_result< T >::mean_result

(

const mean_result< T > &

other

)

Definition at line 133 of file mean.cpp.

Member Function Documentation

template<typename T>

size_t alps::alea::mean_result< T >::count ( ) const

inline

Returns sample size, i.e., number of accumulated data points

Definition at line 184 of file mean.hpp.

template<typename T>

const column<T>& alps::alea::mean_result< T >::mean ( ) const

inline

Returns sample mean

Definition at line 187 of file mean.hpp.

template<typename T >

mean_result< T > & alps::alea::mean_result< T >::operator=

(

const mean_result< T > &

other

)

Definition at line 138 of file mean.cpp.

template<typename T>

void alps::alea::mean_result< T >::reduce ( const reducer &  r )

inline

Collect measurements from different instances using sum-reducer

Definition at line 196 of file mean.hpp.

template<typename T >

void alps::alea::mean_result< T >::reduce ( const reducer &  r, bool  do_pre_commit, bool  do_post_commit  )

protected

Definition at line 160 of file mean.cpp.

template<typename T>

size_t alps::alea::mean_result< T >::size ( ) const

inline

Number of components of the random vector (e.g., size of mean)

Definition at line 181 of file mean.hpp.

template<typename T>

const mean_data<T>& alps::alea::mean_result< T >::store ( ) const

inline

Return backend object used for storing estimands

Definition at line 190 of file mean.hpp.

template<typename T>

mean_data<T>& alps::alea::mean_result< T >::store ( )

inline

Return backend object used for storing estimands

Definition at line 193 of file mean.hpp.

template<typename T>

bool alps::alea::mean_result< T >::valid ( ) const

inline

Returns false if finalize() has been called, true otherwise

Definition at line 178 of file mean.hpp.

Friends And Related Function Documentation

template<typename T>

void deserialize ( deserializer &  s, const std::string &  key, mean_result< T > &  self  )

friend

Result to a permanent format (write to disk etc.)

Definition at line 198 of file mean.cpp.

template<typename T>

friend class mean_acc< T >

friend

Definition at line 213 of file mean.hpp.

template<typename T>

std::ostream& operator<< ( std::ostream &  str, const mean_result< T > &  self  )

friend

Write some info about the result to a stream

Definition at line 223 of file mean.cpp.

template<typename T>

void serialize ( serializer &  s, const std::string &  key, const mean_result< T > &  self  )

friend

Convert result to a permanent format (write to disk etc.)

Definition at line 185 of file mean.cpp.

---

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

• alps/alea/internal/joined.hpp
• alps/alea/mean.hpp
• mean.cpp