benchmax::BenchmarkResult Struct Reference

Results for a single benchmark run. More...

#include <BenchmarkResult.h>

Collaboration diagram for benchmax::BenchmarkResult:

Public Member Functions
template<typename TimeLimit >
void	cleanup (const TimeLimit &limit)
	Properly detect timeouts. More...
auto	get_path () const
void	store (size_t id) const
void	store () const
void	restore () const
void	forget () const

Data Fields
int	exitCode
	Shell exit code. More...
std::chrono::milliseconds	time
	Runtime in milliseconds. More...
std::string	answer
	Answer string. More...
std::size_t	peak_memory_kbytes
	Peak memory usage. More...
std::string	stdout
	Standard output (mostly for parsing the answer and additional information). More...
std::string	stderr
	Error output (mostly for parsing the answer and additional information). More...
std::map< std::string, std::string >	additional
	Arbitrary additional information that can be provided by the tool class. More...
size_t	stored_id = 0
	Identifier for temporary file. More...

Detailed Description

Results for a single benchmark run.

Definition at line 20 of file BenchmarkResult.h.

Member Function Documentation

cleanup()

template<typename TimeLimit >

void benchmax::BenchmarkResult::cleanup ( const TimeLimit &  limit )

inline

Properly detect timeouts.

Most backends give processes a bit more time to avoid having race-condition-like situations.

Definition at line 43 of file BenchmarkResult.h.

forget()

void benchmax::BenchmarkResult::forget ( ) const

inline

Definition at line 76 of file BenchmarkResult.h.

Here is the call graph for this function:

get_path()

auto benchmax::BenchmarkResult::get_path ( ) const

inline

Definition at line 51 of file BenchmarkResult.h.

Here is the caller graph for this function:

restore()

void benchmax::BenchmarkResult::restore ( ) const

inline

Definition at line 69 of file BenchmarkResult.h.

Here is the call graph for this function:

store() [1/2]

void benchmax::BenchmarkResult::store ( ) const

inline

Definition at line 64 of file BenchmarkResult.h.

Here is the call graph for this function:

Here is the caller graph for this function:

store() [2/2]

void benchmax::BenchmarkResult::store ( size_t  id ) const

inline

Definition at line 55 of file BenchmarkResult.h.

Here is the call graph for this function:

Field Documentation

additional

std::map<std::string, std::string> benchmax::BenchmarkResult::additional

mutable

Arbitrary additional information that can be provided by the tool class.

Definition at line 34 of file BenchmarkResult.h.

answer

std::string benchmax::BenchmarkResult::answer

Answer string.

Definition at line 26 of file BenchmarkResult.h.

exitCode

int benchmax::BenchmarkResult::exitCode

Shell exit code.

Definition at line 22 of file BenchmarkResult.h.

peak_memory_kbytes

std::size_t benchmax::BenchmarkResult::peak_memory_kbytes

Peak memory usage.

Definition at line 28 of file BenchmarkResult.h.

stderr

std::string benchmax::BenchmarkResult::stderr

Error output (mostly for parsing the answer and additional information).

Definition at line 32 of file BenchmarkResult.h.

stdout

std::string benchmax::BenchmarkResult::stdout

Standard output (mostly for parsing the answer and additional information).

Definition at line 30 of file BenchmarkResult.h.

stored_id

size_t benchmax::BenchmarkResult::stored_id = 0

mutable

Identifier for temporary file.

Definition at line 36 of file BenchmarkResult.h.

time

std::chrono::milliseconds benchmax::BenchmarkResult::time

Runtime in milliseconds.

Definition at line 24 of file BenchmarkResult.h.

---

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

• benchmax/results/BenchmarkResult.h