A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::StatisticalSummary Class Referenceabstract

Abstract class for calculating statistical data. More...

#include "data-calculator.h"

+ Inheritance diagram for ns3::StatisticalSummary:

Public Member Functions

virtual ~StatisticalSummary ()
 Destructor.
 
virtual long getCount () const =0
 Returns the number of observations.
 
virtual double getMax () const =0
 Returns the maximum of the values.
 
virtual double getMean () const =0
 Returns the mean of the (weighted) observations.
 
virtual double getMin () const =0
 Returns the minimum of the values.
 
virtual double getSqrSum () const =0
 
virtual double getStddev () const =0
 Returns the standard deviation of the (weighted) observations.
 
virtual double getSum () const =0
 
virtual double getVariance () const =0
 Returns the variance of the (weighted) observations.
 

Detailed Description

Abstract class for calculating statistical data.

Definition at line 43 of file data-calculator.h.

Constructor & Destructor Documentation

◆ ~StatisticalSummary()

virtual ns3::StatisticalSummary::~StatisticalSummary ( )
inlinevirtual

Destructor.

Definition at line 49 of file data-calculator.h.

Member Function Documentation

◆ getCount()

virtual long ns3::StatisticalSummary::getCount ( ) const
pure virtual

Returns the number of observations.

Returns
Number of observations

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic(), and ns3::SqliteDataOutput::SqliteOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getMax()

virtual double ns3::StatisticalSummary::getMax ( ) const
pure virtual

Returns the maximum of the values.

Returns
Maximum of values

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic(), and ns3::SqliteDataOutput::SqliteOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getMean()

virtual double ns3::StatisticalSummary::getMean ( ) const
pure virtual

Returns the mean of the (weighted) observations.

Returns
Mean of (weighted) observations

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getMin()

virtual double ns3::StatisticalSummary::getMin ( ) const
pure virtual

Returns the minimum of the values.

Returns
Minimum of values

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic(), and ns3::SqliteDataOutput::SqliteOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getSqrSum()

virtual double ns3::StatisticalSummary::getSqrSum ( ) const
pure virtual
Returns
Sum of squared values
See also
getWeightedSqrSum()

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic(), and ns3::SqliteDataOutput::SqliteOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getStddev()

virtual double ns3::StatisticalSummary::getStddev ( ) const
pure virtual

Returns the standard deviation of the (weighted) observations.

Returns
Standard deviation of (weighted) observations

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic(), and ns3::SqliteDataOutput::SqliteOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getSum()

virtual double ns3::StatisticalSummary::getSum ( ) const
pure virtual
Returns
Sum of values
See also
getWeightedSum()

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.

Referenced by ns3::OmnetDataOutput::OmnetOutputCallback::OutputStatistic(), and ns3::SqliteDataOutput::SqliteOutputCallback::OutputStatistic().

+ Here is the caller graph for this function:

◆ getVariance()

virtual double ns3::StatisticalSummary::getVariance ( ) const
pure virtual

Returns the variance of the (weighted) observations.

Returns
Variance of (weighted) observations

Implemented in ns3::MinMaxAvgTotalCalculator< T >, ns3::MinMaxAvgTotalCalculator< double >, ns3::MinMaxAvgTotalCalculator< uint32_t >, and ns3::MinMaxAvgTotalCalculator< uint64_t >.


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