OpenMD 3.0
Molecular Dynamics in the Open
Loading...
Searching...
No Matches
OpenMD::MatrixAccumulator Class Reference
+ Inheritance diagram for OpenMD::MatrixAccumulator:

Public Member Functions

void add (ElementType const &val)
 Accumulate another value.
 
void clear ()
 reset the Accumulator to the empty state
 
void getLastValue (ElementType &ret)
 return the most recently added value
 
void getAverage (ResultType &ret)
 compute the Mean
 
void getTotal (ResultType &ret)
 return the Total accumulated sum
 
void getVariance (ResultType &ret)
 compute the Variance
 
void getStdDev (ResultType &ret)
 compute error of average value
 
void get95percentConfidenceInterval (ResultType &ret)
 return the 95% confidence interval:
 
- Public Member Functions inherited from OpenMD::BaseAccumulator
virtual size_t count ()
 get the number of accumulated values
 

Additional Inherited Members

- Protected Attributes inherited from OpenMD::BaseAccumulator
size_t Count_ {}
 

Detailed Description

Definition at line 584 of file OldAccumulator.hpp.

Constructor & Destructor Documentation

◆ MatrixAccumulator()

OpenMD::MatrixAccumulator::MatrixAccumulator ( )
inline

Definition at line 589 of file OldAccumulator.hpp.

Member Function Documentation

◆ add()

void OpenMD::MatrixAccumulator::add ( ElementType const & val)
inline

Accumulate another value.

Definition at line 594 of file OldAccumulator.hpp.

◆ clear()

void OpenMD::MatrixAccumulator::clear ( )
inlinevirtual

reset the Accumulator to the empty state

Implements OpenMD::BaseAccumulator.

Definition at line 609 of file OldAccumulator.hpp.

◆ get95percentConfidenceInterval()

void OpenMD::MatrixAccumulator::get95percentConfidenceInterval ( ResultType & ret)
inline

return the 95% confidence interval:

That is returns c, such that we have 95% confidence that the true mean is within 2c of the Average (x):

x - c <= true mean <= x + c

Definition at line 681 of file OldAccumulator.hpp.

References getStdDev().

◆ getAverage()

void OpenMD::MatrixAccumulator::getAverage ( ResultType & ret)
inline

compute the Mean

Definition at line 628 of file OldAccumulator.hpp.

◆ getLastValue()

void OpenMD::MatrixAccumulator::getLastValue ( ElementType & ret)
inline

return the most recently added value

Definition at line 620 of file OldAccumulator.hpp.

◆ getStdDev()

void OpenMD::MatrixAccumulator::getStdDev ( ResultType & ret)
inline

compute error of average value

Definition at line 660 of file OldAccumulator.hpp.

References getVariance().

Referenced by get95percentConfidenceInterval().

◆ getTotal()

void OpenMD::MatrixAccumulator::getTotal ( ResultType & ret)
inline

return the Total accumulated sum

Definition at line 637 of file OldAccumulator.hpp.

◆ getVariance()

void OpenMD::MatrixAccumulator::getVariance ( ResultType & ret)
inline

compute the Variance

Definition at line 646 of file OldAccumulator.hpp.

Referenced by getStdDev().


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