ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalVariance Class Reference

Computing the incremental variance of a discretely sampled signal. More...

#include <ignition/math/SignalStats.hh>

Inheritance diagram for ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalVariance:

Public Member Functions
virtual void	InsertData (const double _data)
	Add a new sample to the statistical measure.
virtual std::string	ShortName () const
	Get a short version of the name of this statistical measure.
virtual double	Value () const
	Get the current value of the statistical measure.
Public Member Functions inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic
	SignalStatistic ()
	Constructor.
	SignalStatistic (const SignalStatistic &_ss)
	Copy constructor.
virtual	~SignalStatistic ()
	Destructor.
virtual size_t	Count () const
	Get number of data points in measurement.
virtual void	Reset ()
	Forget all previous data.

Additional Inherited Members
Protected Attributes inherited from ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic
std::unique_ptr< SignalStatisticPrivate >	dataPtr
	Pointer to private data.

Detailed Description

Computing the incremental variance of a discretely sampled signal.

Member Function Documentation

InsertData()

virtual void ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalVariance::InsertData ( const double _data )

virtual

Add a new sample to the statistical measure.

Parameters

[in]

_data

New signal data point.

Implements ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic.

ShortName()

virtual std::string ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalVariance::ShortName ( ) const

virtual

Get a short version of the name of this statistical measure.

Returns

"var"

Implements ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic.

Value()

virtual double ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalVariance::Value ( ) const

virtual

Get the current value of the statistical measure.

Returns

Current value of the statistical measure.

Implements ignition::math::IGNITION_MATH_VERSION_NAMESPACE::SignalStatistic.

---

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

• SignalStats.hh