Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
o2scl::expval_vector Class Reference

Vector expectation value. More...

#include <expval.h>

Inheritance diagram for o2scl::expval_vector:
o2scl::expval_base

Public Types

typedef boost::numeric::ublas::vector< double > ubvector
 
typedef boost::numeric::ublas::matrix< double > ubmatrix
 

Public Member Functions

 expval_vector (size_t n, size_t n_blocks=1, size_t n_per_block=1)
 Create for a vector of size n with n_blocks blocks and n_per_block points block.
 
 expval_vector (const expval_vector &ev)
 Copy constructor.
 
expval_vectoroperator= (const expval_vector &ev)
 Copy constructor.
 
virtual void set_blocks (size_t n, size_t n_blocks, size_t n_per_block)
 Set for a vector of size n with n_blocks blocks and n_per_block points block.
 
virtual void free ()
 Free allocated data (but do not change the current values of n_blocks or n_per_block)
 
template<class vec_t >
void add (vec_t &val)
 Add measurement of value val.
 
const ubmatrixget_data () const
 Return the current data for all blocks.
 
Report statistics
template<class vec_t , class vec2_t , class vec3_t >
void current_avg_stats (vec_t &avg, vec2_t &std_dev, vec3_t &avg_err, size_t &m_block, size_t &m_per_block)
 Report current average, standard deviation, and the error in the average and include block information. More...
 
template<class vec_t , class vec2_t , class vec3_t >
void current_avg (vec_t &avg, vec2_t &std_dev, vec3_t &avg_err)
 Report current average, standard deviation, and the error in the average. More...
 
template<class vec_t , class vec2_t , class vec3_t >
void reblock_avg_stats (size_t new_blocks, vec_t &avg, vec2_t &std_dev, vec3_t &avg_err, size_t &m_per_block) const
 Report average, standard deviation, and the error in the average assuming a new block size.
 
template<class vec_t , class vec2_t , class vec3_t >
void reblock_avg (size_t new_blocks, vec_t &avg, vec2_t &std_dev, vec3_t &avg_err) const
 Report average, standard deviation, and the error in the average assuming a new block size.
 
- Public Member Functions inherited from o2scl::expval_base
 expval_base (size_t n_blocks=1, size_t n_per_block=1)
 Create with n_blocks blocks and n_per_block points per block. More...
 
 expval_base (const expval_base &ev)
 Copy constructor.
 
expval_baseoperator= (const expval_base &ev)
 Copy constructor with operator=()
 
virtual void set_blocks (size_t n_blocks, size_t n_per_block)
 Reset for n_blocks blocks and n_per_block points per block. More...
 
virtual void get_blocks (size_t &n_blocks, size_t &n_per_block) const
 Get the number of blocks and the number of points per block.
 
virtual void get_block_indices (size_t &i_block, size_t &i_curr_block) const
 Get the block index and the index within the current block.
 
virtual bool finished () const
 Returns true if all blocks have been stored. More...
 
virtual double progress () const
 Report progress as a fraction between zero to one (inclusive) More...
 
void is_valid () const
 Internal consistency check.
 

Protected Attributes

ubmatrix vals
 The average for each block. More...
 
ubvector current
 The current rolling average.
 
size_t nvec
 The size of the vector.
 
- Protected Attributes inherited from o2scl::expval_base
size_t iblock
 Index denoting the current block number.
 
size_t i
 Index for the number of values in the current block.
 
size_t nblocks
 Total number of blocks (default 1) More...
 
size_t nperblock
 Number of measurements per block (default 1) More...
 

Friends

void o2scl_hdf::hdf_output (o2scl_hdf::hdf_file &hf, expval_vector &t, std::string name)
 
void o2scl_hdf::hdf_input (o2scl_hdf::hdf_file &hf, expval_vector &t, std::string name)
 

Additional Inherited Members

- Public Attributes inherited from o2scl::expval_base
std::string name
 The name of the expectation value.
 
std::string short_name
 The shortened name.
 

Detailed Description

See expval_base for some general notes on this and related classes.

This is a similar to expval_scalar, except that it allows updating and statistics for a set of scalars en masse. The data is stored internally in ublas vector and matrix object, but the public member functions operate with template types which are compatible with any vector class which provides double &operator[]. It is assumed that each call to add() contains a new measurement for all of the vector indices.

Definition at line 304 of file expval.h.

Member Function Documentation

◆ current_avg()

template<class vec_t , class vec2_t , class vec3_t >
void o2scl::expval_vector::current_avg ( vec_t &  avg,
vec2_t &  std_dev,
vec3_t &  avg_err 
)
inline
Idea for Future:
This can't be const because of ubmatrix_row in current_avg_stats(), but should be made const later.

Definition at line 479 of file expval.h.

◆ current_avg_stats()

template<class vec_t , class vec2_t , class vec3_t >
void o2scl::expval_vector::current_avg_stats ( vec_t &  avg,
vec2_t &  std_dev,
vec3_t &  avg_err,
size_t &  m_block,
size_t &  m_per_block 
)
inline
Idea for Future:
This can't be const because of ubmatrix_row, but should be made const later.

Definition at line 426 of file expval.h.

Member Data Documentation

◆ vals

ubmatrix o2scl::expval_vector::vals
protected

The first (row) index is the user-specified vector index and the second (column) index as the block index.

Definition at line 318 of file expval.h.


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

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).