WallTimer Struct Reference

A timer class measuring wall-clock time using std::chrono::high_resolution_clock. More...

#include <data.hpp>

Public Member Functions
	WallTimer ()=default
	Default constructor.
size_t	elapsed_nanoseconds () const noexcept
	Calculates the elapsed time since the timer was started.
void	start (const std::string &prompt="", bool reset=true) noexcept
	Starts or resets the timer and optionally prints a starting message.
size_t	print () noexcept
	Prints the elapsed time since the last start/reset to stdout.

Public Attributes
std::chrono::high_resolution_clock::time_point	start_time

Detailed Description

A timer class measuring wall-clock time using std::chrono::high_resolution_clock.

Provides methods to start the timer, get the elapsed time, and print the elapsed time. Suitable for measuring the real time elapsed, including potential waits or system overhead.

Definition at line 115 of file data.hpp.

Constructor & Destructor Documentation

WallTimer()

WallTimer::WallTimer ( )

default

Default constructor.

Member Function Documentation

elapsed_nanoseconds()

size_t WallTimer::elapsed_nanoseconds ( ) const

inlinenoexcept

Calculates the elapsed time since the timer was started.

Returns

size_t The elapsed time in nanoseconds.

Definition at line 126 of file data.hpp.

    {
        auto end = std::chrono::high_resolution_clock::now();
        auto duration = std::chrono::duration_cast<std::chrono::nanoseconds>(end - start_time);
        return duration.count();
    }

print()

size_t WallTimer::print ( )

inlinenoexcept

Prints the elapsed time since the last start/reset to stdout.

Calculates the elapsed time, formats it using pretty_print, and prints "done (formatted_time)\n".

Returns

size_t The elapsed time in nanoseconds that was printed.

Definition at line 158 of file data.hpp.

    {
        auto nanoseconds = elapsed_nanoseconds();
        printf("done (%s)\n", pretty_print(nanoseconds).c_str());
        fflush(stdout); // Ensure the output is displayed immediately
        return nanoseconds;
    }

start()

void WallTimer::start ( const std::string &  prompt = "", bool  reset = true  )

inlinenoexcept

Starts or resets the timer and optionally prints a starting message.

Parameters

prompt	A message to print to stdout indicating what is being timed. If empty, no message is printed.
reset	If true (default), resets the start time. If false, keeps the previous start time (useful for cumulative timing).

Definition at line 138 of file data.hpp.

    {
        if (reset)
        {
            start_time = std::chrono::high_resolution_clock::now();
        }
 
        if (!prompt.empty())
        {
            // Use printf for potentially better performance in tight loops compared to std::cout
            printf("%s... \t", prompt.c_str());
            fflush(stdout); // Ensure the prompt is displayed immediately
        }
    }

Member Data Documentation

start_time

std::chrono::high_resolution_clock::time_point WallTimer::start_time

Stores the time point when the timer was last started/reset.

Definition at line 117 of file data.hpp.

---

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

• src/data.hpp