foray::bench::HostBenchmark Class Reference

A host (CPU time) benchmark based on std::chrono::high_resolution_clock. Timestamps are recorded in milliseconds. More...

#include <foray_hostbenchmark.hpp>

Inheritance diagram for foray::bench::HostBenchmark:

Public Member Functions
void	Begin ()
	Begins a new benchmark and records the "Begin" timestamp.
void	LogTimestamp (const char *id)
	Logs timestamp of id.
void	End ()
	Records the "End" timestamp and finalizes the benchmark.
Public Member Functions inherited from foray::bench::BenchmarkBase
	BenchmarkBase ()

Additional Inherited Members
Protected Member Functions inherited from foray::bench::BenchmarkBase
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 inherited from foray::bench::BenchmarkBase
std::vector< BenchmarkLog >	mLogs
BenchmarkLog	mCurrentLog
bool	mRecording = false

Detailed Description

A host (CPU time) benchmark based on std::chrono::high_resolution_clock. Timestamps are recorded in milliseconds.

Member Function Documentation

Begin()

void foray::bench::HostBenchmark::Begin

(

)

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

End()

void foray::bench::HostBenchmark::End

(

)

Records the "End" timestamp and finalizes the benchmark.

LogTimestamp()

void foray::bench::HostBenchmark::LogTimestamp

(

const char *

id

)

Logs timestamp of id.

---

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

• src/bench/foray_hostbenchmark.hpp