Catch::BenchmarkLooper Class Reference

#include <catch_benchmark.h>

Public Member Functions
	BenchmarkLooper (StringRef name)
	operator bool ()
void	increment ()
void	reportStart ()
auto	needsMoreIterations () -> bool
	BenchmarkLooper (StringRef name)
	operator bool ()
void	increment ()
void	reportStart ()
auto	needsMoreIterations () -> bool

Detailed Description

Definition at line 2572 of file catch.hpp.

Constructor & Destructor Documentation

BenchmarkLooper() [1/2]

Catch::BenchmarkLooper::BenchmarkLooper ( StringRef name )

inline

Definition at line 30 of file catch_benchmark.h.

        :   m_name( name ),
            m_resolution( getResolution() )
        {
            reportStart();
            m_timer.start();
        }

Here is the call graph for this function:

BenchmarkLooper() [2/2]

Catch::BenchmarkLooper::BenchmarkLooper ( StringRef name )

inline

Definition at line 2583 of file catch.hpp.

        :   m_name( name ),
            m_resolution( getResolution() )
        {
            reportStart();
            m_timer.start();
        }

Here is the call graph for this function:

Member Function Documentation

increment() [1/2]

void Catch::BenchmarkLooper::increment ( )

inline

Definition at line 44 of file catch_benchmark.h.

                         {
            ++m_count;
        }

increment() [2/2]

void Catch::BenchmarkLooper::increment ( )

inline

Definition at line 2597 of file catch.hpp.

                         {
            ++m_count;
        }

needsMoreIterations() [1/2]

auto Catch::BenchmarkLooper::needsMoreIterations

(

)

-> bool

Definition at line 23 of file catch_benchmark.cpp.

                                                      {
        auto elapsed = m_timer.getElapsedNanoseconds();
 
        // Exponentially increasing iterations until we're confident in our timer resolution
        if( elapsed < m_resolution ) {
            m_iterationsToRun *= 10;
            return true;
        }
 
        getResultCapture().benchmarkEnded( { { m_name }, m_count, elapsed } );
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

needsMoreIterations() [2/2]

auto Catch::BenchmarkLooper::needsMoreIterations

(

)

-> bool

operator bool() [1/2]

Catch::BenchmarkLooper::operator bool ( )

inlineexplicit

Definition at line 38 of file catch_benchmark.h.

                                 {
            if( m_count < m_iterationsToRun )
                return true;
            return needsMoreIterations();
        }

Here is the call graph for this function:

operator bool() [2/2]

Catch::BenchmarkLooper::operator bool ( )

inlineexplicit

Definition at line 2591 of file catch.hpp.

                                 {
            if( m_count < m_iterationsToRun )
                return true;
            return needsMoreIterations();
        }

reportStart() [1/2]

void Catch::BenchmarkLooper::reportStart

(

)

Definition at line 20 of file catch_benchmark.cpp.

                                      {
        getResultCapture().benchmarkStarting( { m_name } );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reportStart() [2/2]

void Catch::BenchmarkLooper::reportStart

(

)

---

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

• libraries/sys-vm/external/Catch2/include/internal/catch_benchmark.h
• libraries/sys-vm/external/Catch2/single_include/catch2/catch.hpp
• libraries/sys-vm/external/Catch2/include/internal/catch_benchmark.cpp