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

#include <autocorr.hpp>

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

Public Types
typedef T	value_type
typedef bind< circular_var, T >::var_type	var_type
typedef var_result< T, circular_var >	level_result_type

Public Member Functions
	autocorr_result (size_t nlevel=0)
bool	valid () const
size_t	size () const
size_t	count () const
double	count2 () const
const column< T > &	mean () const
column< var_type >	var () const
column< var_type >	stderror () const
column< var_type >	tau () const
bool	tau_available () const
void	reduce (const reducer &r)
size_t	find_level (size_t min_samples) const
size_t	batch_size (size_t level) const
size_t	nlevel () const
const level_result_type &	level (size_t i) const
level_result_type &	level (size_t i)

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

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

Detailed Description

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

Result for the integrated autocorrelation time.

See also

alps::alea::autocorr_acc

Definition at line 18 of file autocorr.hpp.

Member Typedef Documentation

template<typename T>

typedef var_result<T, circular_var> alps::alea::autocorr_result< T >::level_result_type

Definition at line 152 of file autocorr.hpp.

template<typename T>

typedef T alps::alea::autocorr_result< T >::value_type

Definition at line 150 of file autocorr.hpp.

template<typename T>

typedef bind<circular_var, T>::var_type alps::alea::autocorr_result< T >::var_type

Definition at line 151 of file autocorr.hpp.

Constructor & Destructor Documentation

template<typename T>

alps::alea::autocorr_result< T >::autocorr_result ( size_t  nlevel = 0 )

inline

Definition at line 155 of file autocorr.hpp.

Member Function Documentation

template<typename T >

size_t alps::alea::autocorr_result< T >::batch_size

(

size_t

level

)

const

Definition at line 152 of file autocorr.cpp.

template<typename T>

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

inline

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

Definition at line 164 of file autocorr.hpp.

template<typename T >

double alps::alea::autocorr_result< T >::count2

(

)

const

Returns sum of squared samples sizes

Definition at line 169 of file autocorr.cpp.

template<typename T >

size_t alps::alea::autocorr_result< T >::find_level

(

size_t

min_samples

)

const

Definition at line 158 of file autocorr.cpp.

template<typename T>

const level_result_type& alps::alea::autocorr_result< T >::level ( size_t  i ) const

inline

Definition at line 202 of file autocorr.hpp.

template<typename T>

level_result_type& alps::alea::autocorr_result< T >::level ( size_t  i )

inline

Definition at line 204 of file autocorr.hpp.

template<typename T>

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

inline

Returns sample mean

Definition at line 170 of file autocorr.hpp.

template<typename T>

size_t alps::alea::autocorr_result< T >::nlevel ( ) const

inline

Definition at line 200 of file autocorr.hpp.

template<typename T>

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

inline

Collect measurements from different instances using sum-reducer

Definition at line 185 of file autocorr.hpp.

template<typename T >

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

protected

Definition at line 210 of file autocorr.cpp.

template<typename T>

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

inline

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

Definition at line 161 of file autocorr.hpp.

template<typename T >

column< typename autocorr_result< T >::var_type > alps::alea::autocorr_result< T >::stderror

(

)

const

Returns bias-corrected standard error of the mean

Definition at line 189 of file autocorr.cpp.

template<typename T >

column< typename autocorr_result< T >::var_type > alps::alea::autocorr_result< T >::tau

(

)

const

Returns integrated auto-correlation time

Definition at line 200 of file autocorr.cpp.

template<typename T>

bool alps::alea::autocorr_result< T >::tau_available ( ) const

inline

Is sample size sufficient to estimate integrated auto-correlation time?

Definition at line 182 of file autocorr.hpp.

template<typename T>

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

inline

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

Definition at line 158 of file autocorr.hpp.

template<typename T >

column< typename autocorr_result< T >::var_type > alps::alea::autocorr_result< T >::var

(

)

const

Returns bias-corrected sample variance

Definition at line 179 of file autocorr.cpp.

Friends And Related Function Documentation

template<typename T>

friend class autocorr_acc< T >

friend

Definition at line 213 of file autocorr.hpp.

template<typename T>

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

friend

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

Definition at line 262 of file autocorr.cpp.

template<typename T>

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

friend

Write some info about the result to a stream

Definition at line 293 of file autocorr.cpp.

template<typename T>

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

friend

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

Definition at line 243 of file autocorr.cpp.

---

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

• alps/alea/autocorr.hpp
• autocorr.cpp