foray::bench::BenchmarkBase Class Reference

Base class for all benchmark types. More...

#include <foray_benchmarkbase.hpp>

Inheritance diagram for foray::bench::BenchmarkBase:

Public Member Functions
	BenchmarkBase ()

Protected Member Functions
void	Begin (fp64_t timestamp)
	Begins a new benchmark and records the "Begin" timestamp.
void	LogTimestamp (const char *id, fp64_t timestamp)
	Logs timestamp of id.
void	End (fp64_t timestamp)
	Records the "End" timestamp and finalizes the benchmark.

Protected Attributes
std::vector< BenchmarkLog >	mLogs
BenchmarkLog	mCurrentLog
bool	mRecording = false

Detailed Description

Base class for all benchmark types.

Constructor & Destructor Documentation

BenchmarkBase()

foray::bench::BenchmarkBase::BenchmarkBase

(

)

Member Function Documentation

Begin()

void foray::bench::BenchmarkBase::Begin ( fp64_t  timestamp )

protected

Begins a new benchmark and records the "Begin" timestamp.

End()

void foray::bench::BenchmarkBase::End ( fp64_t  timestamp )

protected

Records the "End" timestamp and finalizes the benchmark.

LogTimestamp()

void foray::bench::BenchmarkBase::LogTimestamp ( const char *  id, fp64_t  timestamp  )

protected

Logs timestamp of id.

Member Data Documentation

mCurrentLog

BenchmarkLog foray::bench::BenchmarkBase::mCurrentLog

protected

mLogs

std::vector<BenchmarkLog> foray::bench::BenchmarkBase::mLogs

protected

mRecording

bool foray::bench::BenchmarkBase::mRecording = false

protected

---

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

• src/bench/foray_benchmarkbase.hpp