OpenDDS::DCPS::Stats< DataType > Class Template Reference

Accumulates average, n, variance, minimum, and maximum statistics. More...

#include <Stats_T.h>

Inheritance diagram for OpenDDS::DCPS::Stats< DataType >:

[legend]Collaboration diagram for OpenDDS::DCPS::Stats< DataType >:

[legend]List of all members.

Public Member Functions
	Stats (unsigned int amount=0, typename DataCollector< DataType >::OnFull type=DataCollector< DataType >::KeepOldest)
	Default constructor.
Stats &	operator= (const Stats &rhs)
	Assignment operator.
void	reset ()
	Reset statistics to nil.
void	add (DataType value)
long double	mean () const
	Calculate the average value.
long double	var () const
	Calculate the variance value.
DataType	minimum () const
	Access the minimum value.
DataType	maximum () const
	Access the maximum value.
unsigned long	n () const
	Access the number of values accumulated.
Private Attributes
unsigned long	n_
DataType	minimum_
DataType	maximum_
long double	an_
long double	bn_
long double	cn_
long double	variance_

---

Detailed Description

template<typename DataType>
class OpenDDS::DCPS::Stats< DataType >

Accumulates average, n, variance, minimum, and maximum statistics.

---

Constructor & Destructor Documentation

template<typename DataType>

OpenDDS::DCPS::Stats< DataType >::Stats	(	unsigned int	amount = 0,
		typename DataCollector< DataType >::OnFull	type = DataCollector< DataType >::KeepOldest
	)			[inline]

Default constructor.

---

Member Function Documentation

template<typename DataType>

void OpenDDS::DCPS::Stats< DataType >::add

(

DataType

value

)

[inline]

Accumulate a new value.

Parameters:

value

the new value to be accumulated.

template<typename DataType>

DataType OpenDDS::DCPS::Stats< DataType >::maximum

(

)

const [inline]

Access the maximum value.

: return qNaN with no data.

template<typename DataType>

long double OpenDDS::DCPS::Stats< DataType >::mean

(

)

const [inline]

Calculate the average value.

: return qNaN with no data.

template<typename DataType>

DataType OpenDDS::DCPS::Stats< DataType >::minimum

(

)

const [inline]

Access the minimum value.

: return qNaN with no data.

template<typename DataType>

unsigned long OpenDDS::DCPS::Stats< DataType >::n

(

)

const [inline]

Access the number of values accumulated.

template<typename DataType>

Stats< DataType > & OpenDDS::DCPS::Stats< DataType >::operator=

(

const Stats< DataType > &

rhs

)

[inline]

Assignment operator.

template<typename DataType>

void OpenDDS::DCPS::Stats< DataType >::reset

(

)

[inline]

Reset statistics to nil.

template<typename DataType>

long double OpenDDS::DCPS::Stats< DataType >::var

(

)

const [inline]

Calculate the variance value.

---

Member Data Documentation

template<typename DataType>

long double OpenDDS::DCPS::Stats< DataType >::an_ [private]

template<typename DataType>

long double OpenDDS::DCPS::Stats< DataType >::bn_ [private]

template<typename DataType>

long double OpenDDS::DCPS::Stats< DataType >::cn_ [private]

template<typename DataType>

DataType OpenDDS::DCPS::Stats< DataType >::maximum_ [private]

template<typename DataType>

DataType OpenDDS::DCPS::Stats< DataType >::minimum_ [private]

template<typename DataType>

unsigned long OpenDDS::DCPS::Stats< DataType >::n_ [private]

template<typename DataType>

long double OpenDDS::DCPS::Stats< DataType >::variance_ [private]

---

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

• Stats_T.h

---