This util class provides an easy way to keep track of iterations per second for any body of code. More...

#include <IPS.hpp>

Public Member Functions
	IPS ()
	Construct a new IPS object.

	~IPS ()
	Construct a new IPS object.

IPS &	operator= (const IPS &OtherIPS)
	Operator equals for IPS class.

void	Tick ()
	This method is used to update the iterations per second counter and recalculate all of the IPS metrics.

double	GetExactIPS () const
	Accessor for the Current I P S private member. This method will return the immediate IPS since the last Tick() call. If called in a loop, this number will likely jump around greatly. If you want a 'smoother' IPS number then call the GetAverageIPS() method.

double	GetAverageIPS () const
	Calculates the average iterations per second.

double	GetHighestIPS () const
	Accessor for the Highest I P S private member.

double	GetLowestIPS () const
	Accessor for the Lowest I P S private member.

double	Get1PercentLow () const
	Accessor for the 1PercentLow I P S private member.

void	Reset ()
	Resets all metrics and frame time history.

Private Member Functions
void	UpdateMetrics ()
	This method is used to calculate the IPS stats. Highest, lowest, and 1 percent low IPS.

Private Attributes
double	m_dCurrentIPS

double	m_dHighestIPS

double	m_dLowestIPS

double	m_d1PercentLow

std::deque< double >	m_dqIPSHistory

std::chrono::high_resolution_clock::time_point	m_tLastUpdateTime

const long unsigned int	m_nMaxMetricsHistorySize = 100

Detailed Description

This util class provides an easy way to keep track of iterations per second for any body of code.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

Constructor & Destructor Documentation

◆ IPS()

IPS::IPS ( )

inline

Construct a new IPS object.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Initialize member variables and objects.
            m_dCurrentIPS  = 0.0;
            m_dHighestIPS  = 0.0;
            m_dLowestIPS   = 9999999;
            m_d1PercentLow = 0.0;
        }

◆ ~IPS()

IPS::~IPS ( )

inline

Construct a new IPS object.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Nothing to destroy.
        }

Member Function Documentation

◆ UpdateMetrics()

void IPS::UpdateMetrics ( )

inlineprivate

This method is used to calculate the IPS stats. Highest, lowest, and 1 percent low IPS.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Check highest IPS.
            if (m_dCurrentIPS > m_dHighestIPS)
            {
                // Update new highest.
                m_dHighestIPS = m_dCurrentIPS;
            }
            // Check lowest IPS.
            if (m_dCurrentIPS < m_dLowestIPS)
            {
                // Update new lowest.
                m_dLowestIPS = m_dCurrentIPS;
            }
 
            // Add current IPS to history.
            m_dqIPSHistory.emplace_back(m_dCurrentIPS);
            // Sort the IPS history vector, this allows us to find the 1% low more easily.
            // Throw out oldest element in deque if size is over given number.
            if (m_dqIPSHistory.size() > m_nMaxMetricsHistorySize)
            {
                m_dqIPSHistory.pop_front();
            }
            // Get the index correlating to the IPS number that was lower than 99% of the rest of the IPS history.
            m_d1PercentLow = *std::min_element(m_dqIPSHistory.begin(), m_dqIPSHistory.end());
        }

Here is the caller graph for this function:

◆ operator=()

IPS & IPS::operator= ( const IPS & OtherIPS )

inline

Operator equals for IPS class.

Parameters

OtherIPS - The IPS object to copy values from.

Returns: IPS& - A reference to this object.

Author: clayjay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-10-10

        {
            // Copy values from other IPS object.
            m_dCurrentIPS  = OtherIPS.m_dCurrentIPS;
            m_dHighestIPS  = OtherIPS.m_dHighestIPS;
            m_dLowestIPS   = OtherIPS.m_dLowestIPS;
            m_d1PercentLow = OtherIPS.m_d1PercentLow;
            m_dqIPSHistory = OtherIPS.m_dqIPSHistory;
 
            // Return this object.
            return *this;
        }

◆ Tick()

void IPS::Tick ( )

inline

This method is used to update the iterations per second counter and recalculate all of the IPS metrics.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Get the current and elapsed time.
            std::chrono::time_point tCurrentTime = std::chrono::high_resolution_clock::now();
            long int nElapsedTimeSinceLastTick   = std::chrono::duration_cast<std::chrono::microseconds>(tCurrentTime - m_tLastUpdateTime).count();
 
            // Calculate current IPS. 1 second == 1000000 microseconds.
            m_dCurrentIPS = 1e6 / static_cast<double>(nElapsedTimeSinceLastTick);
 
            // Calculate IPS overall stats.
            this->UpdateMetrics();
 
            // Set current time to old.
            m_tLastUpdateTime = tCurrentTime;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetExactIPS()

double IPS::GetExactIPS ( ) const

inline

Accessor for the Current I P S private member. This method will return the immediate IPS since the last Tick() call. If called in a loop, this number will likely jump around greatly. If you want a 'smoother' IPS number then call the GetAverageIPS() method.

Returns: double - The calculated IPS value since the last iteration.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Return current iterations per second.
            return m_dCurrentIPS;
        }

Here is the caller graph for this function:

◆ GetAverageIPS()

double IPS::GetAverageIPS ( ) const

inline

Calculates the average iterations per second.

Returns: double - The average iterations per second according to the metrics window.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Check if there is any history.
            if (m_dqIPSHistory.empty())
            {
                // Return zero IPS average.
                return 0.0;
            }
 
            // Loop through IPS history and calculate average.
            double dSum = 0.0;
            for (const double dVal : m_dqIPSHistory)
            {
                // Add FPS to total sum.
                dSum += dVal;
            }
 
            // Return calculated average.
            return dSum / static_cast<double>(m_dqIPSHistory.size());
        }

Here is the caller graph for this function:

◆ GetHighestIPS()

double IPS::GetHighestIPS ( ) const

inline

Accessor for the Highest I P S private member.

Returns: double - The highest recorded IPS over this objects lifespan.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Return the highest iterations per second.
            return m_dHighestIPS;
        }

◆ GetLowestIPS()

double IPS::GetLowestIPS ( ) const

inline

Accessor for the Lowest I P S private member.

Returns: double - The lowest recorded IPS over this objects lifespan.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Return the lowest iterations per second.
            return m_dLowestIPS;
        }

◆ Get1PercentLow()

double IPS::Get1PercentLow ( ) const

inline

Accessor for the 1PercentLow I P S private member.

Returns: double - The recorded 1% low within the given metrics window size.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-08-17

        {
            // Return the 1% low for IPS.
            return m_d1PercentLow;
        }

◆ Reset()

void IPS::Reset ( )

inline

Resets all metrics and frame time history.

Author: ClayJay3 (clayt.nosp@m.onra.nosp@m.ycowe.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om)

Date: 2023-09-07

        {
            // Reset member variable.
            m_dCurrentIPS  = 0.0;
            m_dHighestIPS  = 0.0;
            m_dLowestIPS   = 9999999;
            m_d1PercentLow = 0.0;
            // Reset deque.
            m_dqIPSHistory.clear();
        }

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

src/util/IPS.hpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IPS()

◆ ~IPS()

Member Function Documentation

◆ UpdateMetrics()

◆ operator=()

◆ Tick()

◆ GetExactIPS()

◆ GetAverageIPS()

◆ GetHighestIPS()

◆ GetLowestIPS()

◆ Get1PercentLow()

◆ Reset()