Celero
Public Member Functions | Protected Member Functions | List of all members
celero::UserDefinedMeasurementTemplate< T > Class Template Reference

Base class that the user must derive user-defined measurements from. More...

#include <UserDefinedMeasurementTemplate.h>

Inheritance diagram for celero::UserDefinedMeasurementTemplate< T >:
Inheritance graph
[legend]
Collaboration diagram for celero::UserDefinedMeasurementTemplate< T >:
Collaboration graph
[legend]

Public Member Functions

 UserDefinedMeasurementTemplate ()=default
 Default constructor.
 
virtual ~UserDefinedMeasurementTemplate ()=default
 Default destructor.
 
UDMAggregationTable getAggregationInfo () const override
 Must be implemented by the user. More...
 
void addValue (T x)
 You must call this method from your fixture to add a measurement.
 
void merge (const UserDefinedMeasurement *const x) override
 Preserve measurements within a group/experiment/problem space set.
 
- Public Member Functions inherited from celero::UserDefinedMeasurement
virtual ~UserDefinedMeasurement ()=default
 Expose the default destructor, but make it virtual to support inheritance.
 
virtual std::string getName () const =0
 Must be implemented by the user. More...
 

Protected Member Functions

virtual bool reportSize () const
 
virtual bool reportMean () const
 
virtual bool reportVariance () const
 
virtual bool reportStandardDeviation () const
 
virtual bool reportSkewness () const
 
virtual bool reportKurtosis () const
 
virtual bool reportZScore () const
 
virtual bool reportMin () const
 
virtual bool reportMax () const
 
const Statistics< T > & getStatistics () const
 

Detailed Description

template<typename T>
class celero::UserDefinedMeasurementTemplate< T >

Base class that the user must derive user-defined measurements from.

Author
Lukas Barth, John Farrier

Member Function Documentation

◆ getAggregationInfo()

template<typename T>
UDMAggregationTable celero::UserDefinedMeasurementTemplate< T >::getAggregationInfo ( ) const
inlineoverridevirtual

Must be implemented by the user.

Must return a specification which aggregations the user wants to be computed.

Implements celero::UserDefinedMeasurement.


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