ALPSCore reference
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
alps::alea::batch_result< T > Class Template Reference

#include <autocorr.hpp>

Collaboration diagram for alps::alea::batch_result< T >:
Collaboration graph

Public Types

typedef T value_type
 

Public Member Functions

 batch_result ()
 
 batch_result (const batch_data< T > &acc_data)
 
 batch_result (const batch_result &other)
 
batch_resultoperator= (const batch_result &other)
 
bool valid () const
 
size_t size () const
 
size_t num_batches () const
 
size_t count () const
 
double count2 () const
 
column< T > mean () const
 
template<typename Strategy = circular_var>
column< typename bind< Strategy, T >::var_type > var () const
 
template<typename Strategy = circular_var>
eigen< typename bind< Strategy, T >::cov_type >::matrix cov () const
 
column< typename bind< circular_var, T >::var_type > stderror () const
 
const batch_data< T > & store () const
 
batch_data< T > & store ()
 
void reduce (const reducer &r)
 
template<typename Str >
column< typename bind< Str, T >::var_type > var () const
 

Protected Member Functions

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

Friends

class batch_acc< T >
 
void serialize (serializer &, const std::string &, const batch_result &)
 
void deserialize (deserializer &, const std::string &, batch_result &)
 
std::ostream & operator<< (std::ostream &, const batch_result &)
 

Detailed Description

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

Result which contains mean and a naive variance estimate.

Definition at line 20 of file autocorr.hpp.

Member Typedef Documentation

template<typename T>
typedef T alps::alea::batch_result< T >::value_type

Definition at line 173 of file batch.hpp.

Constructor & Destructor Documentation

template<typename T>
alps::alea::batch_result< T >::batch_result ( )
inline

Definition at line 176 of file batch.hpp.

template<typename T>
alps::alea::batch_result< T >::batch_result ( const batch_data< T > &  acc_data)
inline

Definition at line 178 of file batch.hpp.

template<typename T >
alps::alea::batch_result< T >::batch_result ( const batch_result< T > &  other)

Definition at line 200 of file batch.cpp.

Member Function Documentation

template<typename T>
size_t alps::alea::batch_result< T >::count ( ) const
inline

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

Definition at line 196 of file batch.hpp.

template<typename T>
double alps::alea::batch_result< T >::count2 ( ) const
inline

Returns sum of squared sample sizes

Definition at line 199 of file batch.hpp.

template<typename T >
template<typename Str >
template eigen< complex_op< double > >::matrix alps::alea::batch_result< T >::cov< elliptic_var > ( ) const

Returns bias-corrected sample covariance matrix for given strategy

Definition at line 243 of file batch.cpp.

template<typename T >
column< T > alps::alea::batch_result< T >::mean ( ) const

Returns sample mean

Definition at line 224 of file batch.cpp.

template<typename T>
size_t alps::alea::batch_result< T >::num_batches ( ) const
inline

Number of stores batches

Definition at line 193 of file batch.hpp.

template<typename T >
batch_result< T > & alps::alea::batch_result< T >::operator= ( const batch_result< T > &  other)

Definition at line 205 of file batch.cpp.

template<typename T>
void alps::alea::batch_result< T >::reduce ( const reducer r)
inline

Collect measurements from different instances using sum-reducer

Definition at line 222 of file batch.hpp.

template<typename T >
void alps::alea::batch_result< T >::reduce ( const reducer r,
bool  do_pre_commit,
bool  do_post_commit 
)
protected

Definition at line 263 of file batch.cpp.

template<typename T>
size_t alps::alea::batch_result< T >::size ( ) const
inline

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

Definition at line 190 of file batch.hpp.

template<typename T >
column< typename bind< circular_var, T >::var_type > alps::alea::batch_result< T >::stderror ( ) const

Return standard error of the mean

Definition at line 252 of file batch.cpp.

template<typename T>
const batch_data<T>& alps::alea::batch_result< T >::store ( ) const
inline

Return backend object used for storing estimands

Definition at line 216 of file batch.hpp.

template<typename T>
batch_data<T>& alps::alea::batch_result< T >::store ( )
inline

Return backend object used for storing estimands

Definition at line 219 of file batch.hpp.

template<typename T>
bool alps::alea::batch_result< T >::valid ( ) const
inline

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

Definition at line 187 of file batch.hpp.

template<typename T>
template<typename Strategy = circular_var>
column<typename bind<Strategy,T>::var_type> alps::alea::batch_result< T >::var ( ) const

Returns bias-corrected sample variance for given strategy

template<typename T>
template<typename Str >
column<typename bind<Str,T>::var_type> alps::alea::batch_result< T >::var ( ) const

Definition at line 231 of file batch.cpp.

Friends And Related Function Documentation

template<typename T>
friend class batch_acc< T >
friend

Definition at line 239 of file batch.hpp.

template<typename T>
void deserialize ( deserializer s,
const std::string &  key,
batch_result< T > &  self 
)
friend

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

Definition at line 314 of file batch.cpp.

template<typename T>
std::ostream& operator<< ( std::ostream &  str,
const batch_result< T > &  self 
)
friend

Write some info about the result to a stream

Definition at line 345 of file batch.cpp.

template<typename T>
void serialize ( serializer s,
const std::string &  key,
const batch_result< T > &  self 
)
friend

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

Definition at line 294 of file batch.cpp.


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