alps::alea::result Class Reference

#include <result.hpp>

Collaboration diagram for alps::alea::result:

Public Member Functions
	result ()
template<typename T >
	result (const mean_result< T > &res)
template<typename T , typename Str >
	result (const var_result< T, Str > &res)
template<typename T , typename Str >
	result (const cov_result< T, Str > &res)
template<typename T >
	result (const autocorr_result< T > &res)
template<typename T >
	result (const batch_result< T > &res)
bool	valid () const
size_t	size () const
size_t	count () const
template<typename T >
column< T >	mean () const
template<typename T , typename Str = circular_var>
column< typename bind< Str, T >::var_type >	var () const
template<typename T , typename Str = circular_var>
eigen< typename bind< Str, T >::cov_type >::matrix	cov () const

Friends
void	serialize (serializer &, const std::string &, const result &)

Detailed Description

Definition at line 30 of file result.hpp.

Constructor & Destructor Documentation

alps::alea::result::result ( )

inline

Definition at line 33 of file result.hpp.

template<typename T >

alps::alea::result::result ( const mean_result< T > &  res )

inline

Definition at line 36 of file result.hpp.

template<typename T , typename Str >

alps::alea::result::result ( const var_result< T, Str > &  res )

inline

Definition at line 39 of file result.hpp.

template<typename T , typename Str >

alps::alea::result::result ( const cov_result< T, Str > &  res )

inline

Definition at line 42 of file result.hpp.

template<typename T >

alps::alea::result::result ( const autocorr_result< T > &  res )

inline

Definition at line 45 of file result.hpp.

template<typename T >

alps::alea::result::result ( const batch_result< T > &  res )

inline

Definition at line 48 of file result.hpp.

Member Function Documentation

size_t alps::alea::result::count

(

)

const

Returns number of accumulated data points

Definition at line 134 of file result.cpp.

template<typename T , typename Str >

template eigen< double >::matrix alps::alea::result::cov< double, circular_var >

(

)

const

Returns bias-corrected sample covariance matrix for given strategy

Definition at line 159 of file result.cpp.

template<typename T >

template column< double > alps::alea::result::mean< double >

(

)

const

Returns sample mean

Definition at line 140 of file result.cpp.

size_t alps::alea::result::size

(

)

const

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

Definition at line 129 of file result.cpp.

bool alps::alea::result::valid

(

)

const

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

Definition at line 124 of file result.cpp.

template<typename T , typename Str >

template column< double > alps::alea::result::var< double, circular_var >

(

)

const

Returns bias-corrected sample variance for given strategy

Definition at line 149 of file result.cpp.

Friends And Related Function Documentation

void serialize ( serializer &  s, const std::string &  key, const result &  result  )

friend

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

Definition at line 168 of file result.cpp.

---

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

• alps/alea/result.hpp
• result.cpp