SizeLimitedDataQueue< T, NUM_FIELDS > Class Template Reference

collect data with a history limit. More...

Inheritance diagram for SizeLimitedDataQueue< T, NUM_FIELDS >:

Collaboration diagram for SizeLimitedDataQueue< T, NUM_FIELDS >:

Classes
struct	HistoryElement

Public Types
using	value_type = HistoryElement

Public Member Functions
	SizeLimitedDataQueue (size_t size_limit)
void	push (const value_type &val)
	add a new record More...
void	push (value_type &&val)
	add a new record More...
auto	weighted_avg () const
	return weighted average More...
auto	size () const
	return the number of records More...

Private Attributes
std::deque< value_type >	data
const size_t	size_limit_

Detailed Description

template<typename T, size_t NUM_FIELDS>
class qmcplusplus::SizeLimitedDataQueue< T, NUM_FIELDS >

collect data with a history limit.

data stored in std::deque<std::array<T, NUM_FIELDS>>

Definition at line 26 of file SizeLimitedDataQueue.hpp.

---

Class Documentation

qmcplusplus::SizeLimitedDataQueue::HistoryElement

struct qmcplusplus::SizeLimitedDataQueue::HistoryElement

template<typename T, size_t NUM_FIELDS>
struct qmcplusplus::SizeLimitedDataQueue< T, NUM_FIELDS >::HistoryElement

Definition at line 29 of file SizeLimitedDataQueue.hpp.

Collaboration diagram for SizeLimitedDataQueue< T, NUM_FIELDS >::HistoryElement:

Class Members
array< T, NUM_FIELDS >	properties
T	weight

Member Typedef Documentation

value_type

using value_type = HistoryElement

Definition at line 35 of file SizeLimitedDataQueue.hpp.

Constructor & Destructor Documentation

SizeLimitedDataQueue()

SizeLimitedDataQueue ( size_t  size_limit )

inline

Definition at line 37 of file SizeLimitedDataQueue.hpp.

: size_limit_(size_limit) {}

Member Function Documentation

push() [1/2]

void push ( const value_type &  val )

inline

add a new record

Definition at line 40 of file SizeLimitedDataQueue.hpp.

Referenced by DMCRefEnergy::pushWeightEnergyVariance(), and qmcplusplus::TEST_CASE().

  {
    if (data.size() == size_limit_)
      data.pop_front();
    assert(data.size() < size_limit_);
    data.push_back(val);
  }

push() [2/2]

void push ( value_type &&  val )

inline

add a new record

Definition at line 49 of file SizeLimitedDataQueue.hpp.

  {
    if (data.size() == size_limit_)
      data.pop_front();
    assert(data.size() < size_limit_);
    data.push_back(val);
  }

size()

auto size ( void  ) const

inline

return the number of records

Definition at line 75 of file SizeLimitedDataQueue.hpp.

Referenced by DMCRefEnergy::count(), and qmcplusplus::TEST_CASE().

{ return data.size(); }

weighted_avg()

auto weighted_avg ( ) const

inline

return weighted average

Definition at line 58 of file SizeLimitedDataQueue.hpp.

Referenced by DMCRefEnergy::getEnergyVariance(), and qmcplusplus::TEST_CASE().

  {
    std::array<T, NUM_FIELDS> avg;
    std::fill(avg.begin(), avg.end(), T(0));
    T weight_sum = 0;
    for (auto& element : data)
    {
      weight_sum += element.weight;
      for (size_t i = 0; i < NUM_FIELDS; i++)
        avg[i] += element.properties[i] * element.weight;
    }
    for (size_t i = 0; i < NUM_FIELDS; i++)
      avg[i] /= weight_sum;
    return avg;
  }

Member Data Documentation

data

std::deque<value_type> data

private

Definition at line 78 of file SizeLimitedDataQueue.hpp.

Referenced by SizeLimitedDataQueue< FullPrecReal, DataLayout::DATA_SIZE >::push(), SizeLimitedDataQueue< FullPrecReal, DataLayout::DATA_SIZE >::size(), and SizeLimitedDataQueue< FullPrecReal, DataLayout::DATA_SIZE >::weighted_avg().

size_limit_

const size_t size_limit_

private

Definition at line 79 of file SizeLimitedDataQueue.hpp.

Referenced by SizeLimitedDataQueue< FullPrecReal, DataLayout::DATA_SIZE >::push().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Estimators/SizeLimitedDataQueue.hpp