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

#include <Experiment.h>

Classes

class  Impl
 

Public Member Functions

 Experiment (std::weak_ptr< celero::Benchmark > benchmark)
 
 Experiment (std::weak_ptr< celero::Benchmark > benchmark, const std::string &name, uint64_t samples, uint64_t iterations, uint64_t threads, double baselineTarget)
 
 ~Experiment ()
 Default destructor.
 
 Experiment (const Experiment &)=delete
 
Experimentoperator= (Experiment const &other)=delete
 
std::shared_ptr< celero::BenchmarkgetBenchmark ()
 Gets a pointer to the owning Benchmark object.
 
void setName (const std::string &x)
 
std::string getName () const
 
void setSamples (uint64_t x)
 
uint64_t getSamples () const
 
void setIterations (uint64_t x)
 
uint64_t getIterations () const
 
void setThreads (uint64_t x)
 
uint64_t getThreads () const
 
 operator std::string () const
 
std::string getShort () const
 
void setBaselineTarget (double x)
 
double getBaselineTarget () const
 
void incrementTotalRunTime (const uint64_t x)
 
uint64_t getTotalRunTime () const
 
void setIsBaselineCase (bool x)
 Used to set a flag indicating that this is a Baseline case, not a benchmark case.
 
bool getIsBaselineCase () const
 Used to get a flag indicating that this is a Baseline case, not a benchmark case.
 
void setFactory (std::shared_ptr< celero::Factory > x)
 Sets the factory used to create this experiment's test fixtures.
 
std::shared_ptr< celero::FactorygetFactory () const
 Gets the factory used to create this experiment's test fixtures.
 
void addProblemSpace (std::shared_ptr< celero::TestFixture::ExperimentValue > x, double scale=1.0)
 
size_t getResultSize ()
 There is one result for each problem space.
 
std::shared_ptr< celero::ExperimentResultgetResult (size_t x)
 Get an ExperimentResult at a given index.
 
std::shared_ptr< celero::ExperimentResultgetResultByValue (int64_t x)
 Get the ExperimentResult for the given problem space value.
 

Detailed Description

Author
John Farrier

Member Function Documentation

◆ addProblemSpace()

void Experiment::addProblemSpace ( std::shared_ptr< celero::TestFixture::ExperimentValue x,
double  scale = 1.0 
)
Parameters
xCan be interpreted in any way be the test fixture (i.e. index into an array, etc.)
scaleUsed to format unit results.

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