foray::bench::BenchmarkLog Class Reference

Log of a single benchmark run. All timestamps given must be relative to the same base time. More...

#include <foray_benchmarkbase.hpp>

Public Member Functions
std::string	PrintPretty (bool omitTimestamps=true) const
	Prints a table with all timestamps and deltas, aswell as a total delta.
std::string	PrintCsvLine (char separator=';', bool includeNewLine=true) const
	Prints all timestamps, separated by the separator character.
std::string	PrintCsvHeader (char separator=';', bool includeNewLine=true) const
	Prints all timestamps, separated by the separator character.
void	PrintImGui (bool omitTimestamps=true)
	Execute imgui command sequence to display the benchmark results.

Public Attributes
fp64_t	Begin = 0.0
	Value of the first recorded timestamp.
fp64_t	End = 0.0
	Value of the last recorded timestamp.
std::vector< BenchmarkTimestamp >	Timestamps
	List of timestamps in chronological order. Guaranteed to begin with BenchmarkTimestamp::Begin and end with BenchmarkTimestamp::End.
std::vector< fp64_t >	Deltas
	Deltas between the timestamps in milliseconds.

Detailed Description

Log of a single benchmark run. All timestamps given must be relative to the same base time.

Member Function Documentation

PrintCsvHeader()

std::string foray::bench::BenchmarkLog::PrintCsvHeader	(	char	separator = ';',
		bool	includeNewLine = true
	)		const

Prints all timestamps, separated by the separator character.

PrintCsvLine()

std::string foray::bench::BenchmarkLog::PrintCsvLine	(	char	separator = ';',
		bool	includeNewLine = true
	)		const

Prints all timestamps, separated by the separator character.

PrintImGui()

void foray::bench::BenchmarkLog::PrintImGui

(

bool

omitTimestamps = true

)

Execute imgui command sequence to display the benchmark results.

PrintPretty()

std::string foray::bench::BenchmarkLog::PrintPretty

(

bool

omitTimestamps = true

)

const

Prints a table with all timestamps and deltas, aswell as a total delta.

Member Data Documentation

Begin

fp64_t foray::bench::BenchmarkLog::Begin = 0.0

Value of the first recorded timestamp.

Deltas

std::vector<fp64_t> foray::bench::BenchmarkLog::Deltas

Deltas between the timestamps in milliseconds.

End

fp64_t foray::bench::BenchmarkLog::End = 0.0

Value of the last recorded timestamp.

Timestamps

std::vector<BenchmarkTimestamp> foray::bench::BenchmarkLog::Timestamps

List of timestamps in chronological order. Guaranteed to begin with BenchmarkTimestamp::Begin and end with BenchmarkTimestamp::End.

---

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

• src/bench/foray_benchmarkbase.hpp