Celero
Classes | Public Member Functions | List of all members
celero::ExperimentResult Class Reference

#include <ExperimentResult.h>

Classes

class  Impl
 

Public Member Functions

 ExperimentResult (Experiment *x)
 
ExperimentgetExperiment () const
 Gets a pointer to the owning experiment.
 
void setProblemSpaceValue (std::shared_ptr< celero::TestFixture::ExperimentValue > x, double scale=1.0)
 
std::shared_ptr< celero::TestFixture::ExperimentValuegetProblemSpace () const
 
int64_t getProblemSpaceValue () const
 
double getProblemSpaceValueScale () const
 
uint64_t getProblemSpaceIterations () const
 
const Statistics< int64_t > & getTimeStatistics () const
 
const Statistics< int64_t > & getRAMStatistics () const
 
void addRunTimeSample (const uint64_t x)
 Adds a run time sample during experiment execution.
 
void addMemorySample (const int64_t x)
 Adds a memory sample during experiment execution.
 
uint64_t getRunTime () const
 Returns the best run time sample observed.
 
int64_t getRAM () const
 Returns the best RAM usage sample observed.
 
double getUsPerCall () const
 Get the number of computed microseconds per iteration (i.e. More...
 
double getCallsPerSecond () const
 Get the number of times the code under test could be called per second. More...
 
double getUnitsPerSecond () const
 Get the processing speed in units per second. More...
 
double getBaselineMeasurement () const
 Calculate this experiments baseline value. More...
 
void setComplete (bool x)
 Sets a flag indicating if this result is complete.
 
bool getComplete () const
 Gets a flag indicating if this result is complete.
 
void setFailure (bool x)
 Sets a flag indicating if failure happened during evaluation.
 
bool getFailure () const
 Gets a flag indicating if failure happened during evaluation.
 
void setUserDefinedMeasurements (std::shared_ptr< UserDefinedMeasurementCollector > x)
 
std::shared_ptr< UserDefinedMeasurementCollectorgetUserDefinedMeasurements () const
 

Detailed Description

Author
John Farrier

Member Function Documentation

◆ getBaselineMeasurement()

double ExperimentResult::getBaselineMeasurement ( ) const

Calculate this experiments baseline value.

If this IS a baseline experiment, the function will return 1.0; Returns -1 on error.

◆ getCallsPerSecond()

double ExperimentResult::getCallsPerSecond ( ) const

Get the number of times the code under test could be called per second.

A call is defined as one iteration of one execution of the code under test.

◆ getUnitsPerSecond()

double ExperimentResult::getUnitsPerSecond ( ) const

Get the processing speed in units per second.

A call is defined as one iteration of one execution of the code under test.

◆ getUsPerCall()

double ExperimentResult::getUsPerCall ( ) const

Get the number of computed microseconds per iteration (i.e.

a single call to the code under test.)

A call is defined as one iteration of one execution of the code under test.


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