OpenMD::PotVecAccumulator Class Reference

Inheritance diagram for OpenMD::PotVecAccumulator:

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:
void	getMaxLength (RealType &ret)
	return the largest length
void	getMinLength (RealType &ret)
	return the smallest length
void	getAverageLength (RealType &ret)
	return the largest length
void	getLengthVariance (RealType &ret)
	compute the Variance of the length
void	getLengthStdDev (RealType &ret)
	compute error of average value
void	getLength95percentConfidenceInterval (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 392 of file OldAccumulator.hpp.

Constructor & Destructor Documentation

PotVecAccumulator()

OpenMD::PotVecAccumulator::PotVecAccumulator ( )

inline

Definition at line 397 of file OldAccumulator.hpp.

Member Function Documentation

add()

void OpenMD::PotVecAccumulator::add ( ElementType const & val )

inline

Accumulate another value.

Definition at line 402 of file OldAccumulator.hpp.

clear()

void OpenMD::PotVecAccumulator::clear ( )

inlinevirtual

reset the Accumulator to the empty state

Implements OpenMD::BaseAccumulator.

Definition at line 428 of file OldAccumulator.hpp.

get95percentConfidenceInterval()

void OpenMD::PotVecAccumulator::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 498 of file OldAccumulator.hpp.

References getStdDev().

getAverage()

void OpenMD::PotVecAccumulator::getAverage ( ResultType & ret )

inline

compute the Mean

Definition at line 450 of file OldAccumulator.hpp.

getAverageLength()

void OpenMD::PotVecAccumulator::getAverageLength ( RealType & ret )

inline

return the largest length

Definition at line 529 of file OldAccumulator.hpp.

getLastValue()

void OpenMD::PotVecAccumulator::getLastValue ( ElementType & ret )

inline

return the most recently added value

Definition at line 442 of file OldAccumulator.hpp.

getLength95percentConfidenceInterval()

void OpenMD::PotVecAccumulator::getLength95percentConfidenceInterval ( 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 565 of file OldAccumulator.hpp.

References getLengthStdDev().

getLengthStdDev()

void OpenMD::PotVecAccumulator::getLengthStdDev ( RealType & ret )

inline

compute error of average value

Definition at line 548 of file OldAccumulator.hpp.

References getLengthVariance().

Referenced by getLength95percentConfidenceInterval().

getLengthVariance()

void OpenMD::PotVecAccumulator::getLengthVariance ( RealType & ret )

inline

compute the Variance of the length

Definition at line 538 of file OldAccumulator.hpp.

Referenced by getLengthStdDev().

getMaxLength()

void OpenMD::PotVecAccumulator::getMaxLength ( RealType & ret )

inline

return the largest length

Definition at line 511 of file OldAccumulator.hpp.

getMinLength()

void OpenMD::PotVecAccumulator::getMinLength ( RealType & ret )

inline

return the smallest length

Definition at line 520 of file OldAccumulator.hpp.

getStdDev()

void OpenMD::PotVecAccumulator::getStdDev ( ResultType & ret )

inline

compute error of average value

Definition at line 479 of file OldAccumulator.hpp.

References getVariance().

Referenced by get95percentConfidenceInterval().

getTotal()

void OpenMD::PotVecAccumulator::getTotal ( ResultType & ret )

inline

return the Total accumulated sum

Definition at line 459 of file OldAccumulator.hpp.

getVariance()

void OpenMD::PotVecAccumulator::getVariance ( ResultType & ret )

inline

compute the Variance

Definition at line 467 of file OldAccumulator.hpp.

Referenced by getStdDev().

---

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

• utils/OldAccumulator.hpp