unity.scopes.testing.Benchmark.Result

The Result struct encapsulates all of the result gathered from one individual benchmark run consisting of multiple independent trials. More...

#include <unity/scopes/testing/Benchmark.h>

Classes

struct  Timing
 

Public Member Functions

void load_from (std::istream &in)
 load_from restores a result from the given input stream. More...
 
void save_to (std::ostream &out)
 save_to stores a result to the given output stream. More...
 
void load_from_xml (std::istream &in)
 load_from_xml restores a result stored as xml from the given input stream. More...
 
void save_to_xml (std::ostream &out)
 save_to_xml stores a result as xml to the given output stream. More...
 

Public Attributes

std::size_t sample_size
 
unity::scopes::testing::Benchmark::Result::Timing timing
 Runtime-specific sample data.
 

Detailed Description

The Result struct encapsulates all of the result gathered from one individual benchmark run consisting of multiple independent trials.

Member Function Documentation

void unity::scopes::testing::Benchmark::Result::load_from ( std::istream &  in)

load_from restores a result from the given input stream.

Exceptions
std::runtime_errorin case of issues.
Parameters
inThe stream to read from.
void unity::scopes::testing::Benchmark::Result::load_from_xml ( std::istream &  in)

load_from_xml restores a result stored as xml from the given input stream.

Exceptions
std::runtime_errorin case of issues.
Parameters
inThe stream to read from.
void unity::scopes::testing::Benchmark::Result::save_to ( std::ostream &  out)

save_to stores a result to the given output stream.

Exceptions
std::runtime_errorin case of issues.
Parameters
outThe stream to write to.
void unity::scopes::testing::Benchmark::Result::save_to_xml ( std::ostream &  out)

save_to_xml stores a result as xml to the given output stream.

Exceptions
std::runtime_errorin case of issues.
Parameters
outThe stream to write to.

Member Data Documentation

std::size_t unity::scopes::testing::Benchmark::Result::sample_size

Size of the sample, corresponds to number of trials.