accumulator_set< T, typename > Struct Template Reference

generic accumulator of a scalar type More...

Inheritance diagram for accumulator_set< T, typename >:

Collaboration diagram for accumulator_set< T, typename >:

Public Types
enum	{ VALUE = 0, VALUESQ = 1, WEIGHT = 2, CAPACITY = 4 }
using	value_type = T
using	return_type = T

Public Member Functions
	accumulator_set ()
void	operator() (value_type x)
	add a sample More...
void	operator() (value_type x, value_type w)
	add a sample and More...
void	reset (value_type v, value_type vv, value_type w)
	reset properties More...
void	reset (value_type v, value_type w)
	reset properties More...
void	add (value_type x)
	add a value but set the weight 1 More...
bool	good () const
	return true if Weight!= 0 More...
bool	bad () const
	return true if Weight== 0 More...
return_type	result () const
	return the sum More...
return_type	result2 () const
	return the sum of value squared More...
return_type	count () const
	return the count More...
std::pair< return_type, return_type >	mean_and_variance () const
return_type	mean () const
	return the mean More...
return_type	mean2 () const
	return the mean of squared values More...
return_type	variance () const
void	clear ()

Public Attributes
T	properties [CAPACITY]

Detailed Description

template<typename T, typename = typename std::enable_if<std::is_floating_point<T>::value>::type>
struct accumulator_set< T, typename >

generic accumulator of a scalar type

To simplify i/o, the values are storged in contents

Definition at line 32 of file accumulators.h.

Member Typedef Documentation

return_type

using return_type = T

Definition at line 35 of file accumulators.h.

value_type

using value_type = T

Definition at line 34 of file accumulators.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
VALUE
VALUESQ
WEIGHT
CAPACITY

Definition at line 37 of file accumulators.h.

  {
    VALUE    = 0,
    VALUESQ  = 1,
    WEIGHT   = 2,
    CAPACITY = 4
  };

Constructor & Destructor Documentation

accumulator_set()

accumulator_set ( )

inline

Definition at line 46 of file accumulators.h.

  {
    for (int i = 0; i < CAPACITY; ++i)
      properties[i] = value_type();
  }

Member Function Documentation

add()

void add ( value_type  x )

inline

add a value but set the weight 1

Todo:

Jeremy provides the reasonin of having this function. Suggest rename it to make the meaning clear.

Definition at line 95 of file accumulators.h.

  {
    properties[VALUE] += x;
    properties[VALUESQ] += x * x;
    properties[WEIGHT] = 1;
  }

bad()

bool bad ( ) const

inline

return true if Weight== 0

Definition at line 105 of file accumulators.h.

Referenced by qmcplusplus::test_real_accumulator_basic().

{ return qmcplusplus::iszero(properties[WEIGHT]); }

clear()

void clear ( )

inline

Definition at line 139 of file accumulators.h.

Referenced by SimpleFixedNodeBranch::branch(), SimpleFixedNodeBranch::checkParameters(), SimpleFixedNodeBranch::collect(), SimpleFixedNodeBranch::resetRun(), EstimatorManagerBase::start(), and EstimatorManagerNew::startDriverRun().

  {
    for (int i = 0; i < CAPACITY; ++i)
      properties[i] = value_type();
  }

count()

return_type count ( ) const

inline

return the count

Will return the sum of weights of each sample

Definition at line 116 of file accumulators.h.

Referenced by DMCRefEnergy::count(), EstimatorManagerNew::getApproximateEnergyVariance(), EstimatorManagerBase::getApproximateEnergyVariance(), SimpleFixedNodeBranch::read(), qmcplusplus::test_real_accumulator(), qmcplusplus::test_real_accumulator_basic(), qmcplusplus::test_real_accumulator_weights(), and SimpleFixedNodeBranch::write().

{ return properties[WEIGHT]; }

good()

bool good ( ) const

inline

return true if Weight!= 0

Definition at line 103 of file accumulators.h.

Referenced by accumulator_set< FullPrecReal >::mean(), accumulator_set< FullPrecReal >::mean2(), SimpleFixedNodeBranch::read(), and qmcplusplus::test_real_accumulator_basic().

{ return properties[WEIGHT] > 0; }

mean()

return_type mean ( ) const

inline

return the mean

Definition at line 126 of file accumulators.h.

Referenced by SimpleFixedNodeBranch::branch(), SimpleFixedNodeBranch::collect(), EstimatorManagerBase::getApproximateEnergyVariance(), DMCRefEnergy::getEnergyVariance(), SimpleFixedNodeBranch::read(), qmcplusplus::test_real_accumulator(), qmcplusplus::test_real_accumulator_basic(), and qmcplusplus::test_real_accumulator_weights().

{ return good() ? properties[VALUE] / properties[WEIGHT] : 0.0; }

mean2()

return_type mean2 ( ) const

inline

return the mean of squared values

Definition at line 129 of file accumulators.h.

Referenced by qmcplusplus::test_real_accumulator(), qmcplusplus::test_real_accumulator_basic(), and qmcplusplus::test_real_accumulator_weights().

{ return good() ? properties[VALUESQ] / properties[WEIGHT] : 0.0; }

mean_and_variance()

std::pair<return_type, return_type> mean_and_variance ( ) const

inline

Definition at line 118 of file accumulators.h.

Referenced by qmcplusplus::test_real_accumulator(), and qmcplusplus::test_real_accumulator_weights().

  {
    value_type norm = 1.0 / properties[WEIGHT];
    value_type avg  = properties[VALUE] * norm;
    return std::pair<return_type, return_type>(avg, norm * properties[VALUESQ] - avg * avg);
  }

operator()() [1/2]

void operator() ( value_type  x )

inline

add a sample

Definition at line 53 of file accumulators.h.

  {
    properties[VALUE] += x;
    properties[VALUESQ] += x * x;
    properties[WEIGHT] += 1.0;
  }

operator()() [2/2]

void operator() ( value_type  x, value_type  w  )

inline

add a sample and

Definition at line 61 of file accumulators.h.

  {
    properties[VALUE] += w * x;
    properties[VALUESQ] += w * x * x;
    properties[WEIGHT] += w;
  }

reset() [1/2]

void reset ( value_type  v, value_type  vv, value_type  w  )

inline

reset properties

Parameters

v	cummulative value
vv	cummulative valuesq
w	cummulative weight

Definition at line 73 of file accumulators.h.

  {
    properties[VALUE]   = v;
    properties[VALUESQ] = vv;
    properties[WEIGHT]  = w;
  }

reset() [2/2]

void reset ( value_type  v, value_type  w  )

inline

reset properties

Parameters

v	cummulative value
w	cummulative weight

Definition at line 84 of file accumulators.h.

  {
    properties[VALUE]   = v;
    properties[VALUESQ] = v * v;
    properties[WEIGHT]  = w;
  }

result()

return_type result ( ) const

inline

return the sum

Definition at line 108 of file accumulators.h.

Referenced by SimpleFixedNodeBranch::branch(), SimpleFixedNodeBranch::collect(), EstimatorManagerNew::getApproximateEnergyVariance(), EstimatorManagerBase::getApproximateEnergyVariance(), SFNBranch::initParam(), SimpleFixedNodeBranch::initReptile(), SimpleFixedNodeBranch::initWalkerController(), SimpleFixedNodeBranch::read(), qmcplusplus::test_real_accumulator(), qmcplusplus::test_real_accumulator_weights(), SFNBranch::updateParamAfterPopControl(), and SimpleFixedNodeBranch::write().

{ return properties[VALUE]; }

result2()

return_type result2 ( ) const

inline

return the sum of value squared

Definition at line 111 of file accumulators.h.

Referenced by qmcplusplus::test_real_accumulator(), and qmcplusplus::test_real_accumulator_weights().

{ return properties[VALUESQ]; }

variance()

return_type variance ( ) const

inline

Definition at line 131 of file accumulators.h.

Referenced by qmcplusplus::test_real_accumulator(), qmcplusplus::test_real_accumulator_basic(), and qmcplusplus::test_real_accumulator_weights().

  {
    if (qmcplusplus::iszero(properties[WEIGHT]))
      return std::numeric_limits<T>::max();
    value_type norm = 1.0 / properties[WEIGHT];
    return norm * (properties[VALUESQ] - properties[VALUE] * properties[VALUE] * norm);
  }

Member Data Documentation

properties

T properties[CAPACITY]

Definition at line 44 of file accumulators.h.

Referenced by accumulator_set< FullPrecReal >::accumulator_set(), accumulator_set< FullPrecReal >::add(), accumulator_set< FullPrecReal >::bad(), accumulator_set< FullPrecReal >::clear(), accumulator_set< FullPrecReal >::count(), accumulator_set< FullPrecReal >::good(), accumulator_set< FullPrecReal >::mean(), accumulator_set< FullPrecReal >::mean2(), accumulator_set< FullPrecReal >::mean_and_variance(), accumulator_set< FullPrecReal >::operator()(), h5data_proxy< accumulator_set< T > >::read(), accumulator_set< FullPrecReal >::reset(), accumulator_set< FullPrecReal >::result(), accumulator_set< FullPrecReal >::result2(), accumulator_set< FullPrecReal >::variance(), and h5data_proxy< accumulator_set< T > >::write().

---

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

• /home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/Estimators/accumulators.h