#pragma once
#include "EmberDefines.h"
///
/// Timing and CriticalSection classes.
///
namespace EmberNs
{
///
/// Since the algorithm is so computationally intensive, timing and benchmarking are an integral portion
/// of both the development process and the execution results. This class provides an easy way to time
/// things by simply calling its Tic() and Toc() member functions. It also assists with formatting the
/// elapsed time as a string.
///
class EMBER_API Timing
{
public:
///
/// Constructor that takes an optional precision argument which specifies how many digits after the decimal place should be printed for seconds.
/// As a convenience, the Tic() function is called automatically.
///
/// The precision of the seconds field of the elapsed time. Default: 2.
Timing(int precision = 2)
{
m_Precision = precision;
Init();
Tic();
}
///
/// Set the begin time.
///
/// The begin time cast to a double
double Tic()
{
m_BeginTime = Clock::now();
return BeginTime();
}
///
/// Set the end time and optionally output a string showing the elapsed time.
///
/// The string to output. Default: nullptr.
/// If true, output the string verbatim, else output the text " processing time: " in between str and the formatted time.
/// The elapsed time in milliseconds as a double
double Toc(const char* str = nullptr, bool fullString = false)
{
m_EndTime = Clock::now();
double ms = ElapsedTime();
if (str != nullptr)
{
cout << string(str) << (fullString ? "" : " processing time: ") << Format(ms) << endl;
}
return ms;
}
///
/// Return the begin time as a double.
///
///
double BeginTime() { return static_cast(m_BeginTime.time_since_epoch().count()); }
///
/// Return the end time as a double.
///
///
double EndTime() { return static_cast(m_EndTime.time_since_epoch().count()); }
///
/// Return the elapsed time in milliseconds.
///
/// The elapsed time in milliseconds as a double
double ElapsedTime()
{
duration elapsed = duration_cast(m_EndTime - m_BeginTime);
return elapsed.count() * 1000.0;
}
///
/// Formats a specified milliseconds value as a string.
/// This uses some intelligence to determine what to return depending on how much time has elapsed.
/// Days, hours and minutes are only included if 1 or more of them has elapsed. Seconds are always
/// included as a decimal value with the precision the user specified in the constructor.
///
/// The ms
/// The formatted string
string Format(double ms)
{
stringstream ss;
double x = ms / 1000;
double secs = fmod(x, 60);
x /= 60;
double mins = fmod(x, 60);
x /= 60;
double hours = fmod(x, 24);
x /= 24;
double days = x;
if (days >= 1)
ss << static_cast(days) << "d ";
if (hours >= 1)
ss << static_cast(hours) << "h ";
if (mins >= 1)
ss << static_cast(mins) << "m ";
ss << std::fixed << std::setprecision(m_Precision) << secs << "s";
return ss.str();
}
///
/// Return the number of cores in the system.
///
/// The number of cores in the system
static uint ProcessorCount()
{
Init();
return m_ProcessorCount;
}
private:
///
/// Query and store the performance info of the system.
/// Since it will never change it only needs to be queried once.
/// This is achieved by keeping static state and performance variables.
///
static void Init()
{
if (!m_TimingInit)
{
m_ProcessorCount = thread::hardware_concurrency();
m_TimingInit = true;
}
}
int m_Precision;//How many digits after the decimal place to print for seconds.
time_point m_BeginTime;//The start of the timing, set with Tic().
time_point m_EndTime;//The end of the timing, set with Toc().
static bool m_TimingInit;//Whether the performance info has bee queried.
static uint m_ProcessorCount;//The number of cores on the system, set in Init().
};
///
/// Cross platform critical section class which can be used for thread locking.
///
class EMBER_API CriticalSection
{
public:
#ifdef _WIN32
///
/// Constructor which initialized the underlying CRITICAL_SECTION object.
///
CriticalSection() { InitializeCriticalSection(&m_CriticalSection); }
///
/// Constructor which initialized the underlying CRITICAL_SECTION object
/// with the specified spin count value.
///
/// The spin count.
CriticalSection(DWORD spinCount) { InitializeCriticalSectionAndSpinCount(&m_CriticalSection, spinCount); }
///
/// Deletes the underlying CRITICAL_SECTION object.
///
~CriticalSection() { DeleteCriticalSection(&m_CriticalSection); }
///
/// Lock the critical section.
///
void Enter() { EnterCriticalSection(&m_CriticalSection); }
///
/// Unlock the critical section.
///
void Leave() { LeaveCriticalSection(&m_CriticalSection); }
private:
CRITICAL_SECTION m_CriticalSection;//The Windows specific critical section object.
#else
///
/// Constructor which initialized the underlying pthread_mutex_t object.
///
CriticalSection()
{
pthread_mutexattr_t attr;
pthread_mutexattr_init(&attr);
pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_NORMAL);
pthread_mutex_init(&m_CriticalSection, &attr);
pthread_mutexattr_destroy(&attr);
}
///
/// Deletes the underlying pthread_mutex_t object.
///
~CriticalSection() { pthread_mutex_destroy(&m_CriticalSection); }
///
/// Lock the critical section.
///
void Enter() { pthread_mutex_lock(&m_CriticalSection); }
///
/// Unlock the critical section.
///
void Leave() { pthread_mutex_unlock(&m_CriticalSection); }
private:
pthread_mutex_t m_CriticalSection;//The *nix/pthread specific critical section object.
#endif
};
}