Time stamp class. More...

#include <time_stamp.hpp>

Public Member Functions
	TimeStamp ()
	Constructor. More...

double	elapsed (const TimeStamp &before) const
	Calculates the time elapsed between two time stamps. More...

long long	elapsed_micros (const TimeStamp &before) const
	Calculate the time elapsed between two time stamps in microseconds. More...

long long	elapsed_micros_now () const
	Calculates the time elapsed between the time stamp and now in microseconds. More...

double	elapsed_now () const
	Calculates the time elapsed between the time stamp and now. More...

String	elapsed_string (const TimeStamp &before, TimeFormat format=TimeFormat::s_m) const
	Return the time elapsed between two time stamps as a string. More...

String	elapsed_string_now (TimeFormat format=TimeFormat::s_m) const
	Calculates the time elapsed between the time stamp and now as a string. More...

bool	operator< (const TimeStamp &other) const
	Comparison operator. More...

TimeStamp &	stamp ()
	Stamps the current time-stamp. More...

Static Public Member Functions
static String	format_micros (long long micros, TimeFormat format=TimeFormat::s_m)
	Formats an elapsed time in microseconds as a string. More...

Private Attributes
clock_t	_clock
	Our time-stamp. More...

Detailed Description

Time stamp class.

This class is used to store time stamps and compute elapsed times. The implementation of this class depends on the current platform:

For unix/linux systems, this class makes use of the gettimeofday() function.
For Windows systems, this class makes use of the QueryPerformanceCounter() function.
For other systems, this class makes use of the ANSI-C clock() function as a fallback implementation.

Platform dependend code branching:: Windows does not use gettimeofday

Author: Dirk Ribbrock; Peter Zajac

Definition at line 53 of file time_stamp.hpp.

Constructor & Destructor Documentation

◆ TimeStamp()

FEAT::TimeStamp::TimeStamp ( )

inline

Constructor.

Definition at line 67 of file time_stamp.hpp.

References stamp().

Referenced by elapsed_micros_now(), elapsed_now(), and elapsed_string_now().

Member Function Documentation

◆ elapsed()

double FEAT::TimeStamp::elapsed ( const TimeStamp & before ) const

inline

Calculates the time elapsed between two time stamps.

Parameters

[in] before A time stamp that represents a previous moment.

Returns: The time elapsed between the time stamps before and this in seconds.

Definition at line 100 of file time_stamp.hpp.

References _clock, and FEAT::Windows::query_performance_frequency().

◆ elapsed_micros()

long long FEAT::TimeStamp::elapsed_micros ( const TimeStamp & before ) const

inline

Calculate the time elapsed between two time stamps in microseconds.

Parameters

[in] before A time stamp that represents a previous moment.

Returns: The time elapsed between the time stamps before and this in microseconds.

Definition at line 135 of file time_stamp.hpp.

References _clock, and FEAT::Windows::query_performance_frequency().

Referenced by FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_colored(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_layered(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_no_scatter(), FEAT::StopWatch::elapsed_micros(), elapsed_string(), and FEAT::StopWatch::stop().

◆ elapsed_micros_now()

long long FEAT::TimeStamp::elapsed_micros_now ( ) const

inline

Calculates the time elapsed between the time stamp and now in microseconds.

Note: This function does not update (stamp) this time stamp.

Returns: The time elapsed between this time stamp and now in microseconds.

Definition at line 157 of file time_stamp.hpp.

References TimeStamp().

Referenced by FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_colored(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_layered(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_no_scatter(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_single(), and FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::operator()().

◆ elapsed_now()

double FEAT::TimeStamp::elapsed_now ( ) const

inline

Calculates the time elapsed between the time stamp and now.

Note: This function does not update (stamp) this time stamp.

Returns: The time elapsed between this time stamp and now in seconds.

Definition at line 121 of file time_stamp.hpp.

References TimeStamp().

Referenced by FEAT::Geometry::PartiIterative< ConformalMesh< Shape_, num_coords_, Coord_ > >::PartiIterative(), FEAT::Global::SynchScalarTicket< DT_ >::SynchScalarTicket(), FEAT::Global::SynchVectorTicket< VT_, VMT_ >::SynchVectorTicket(), FEAT::Solver::MultiGrid< SystemMatrix_, SystemFilter_, TransferOperator_ >::_apply_coarse(), FEAT::Solver::Vanka< LAFEM::SaddlePointMatrix< MatrixA_, MatrixB_, MatrixD_ >, Filter_ >::_apply_diag(), FEAT::Solver::Vanka< LAFEM::SaddlePointMatrix< MatrixA_, MatrixB_, MatrixD_ >, Filter_ >::_apply_full(), FEAT::Solver::MultiGrid< SystemMatrix_, SystemFilter_, TransferOperator_ >::_apply_prol(), FEAT::Solver::MultiGrid< SystemMatrix_, SystemFilter_, TransferOperator_ >::_apply_rest(), FEAT::Solver::MultiGrid< SystemMatrix_, SystemFilter_, TransferOperator_ >::_apply_smooth_peak(), FEAT::Control::Domain::PartiDomainControl< DomainLevel_ >::_create(), FEAT::Control::Domain::PartiDomainControl< DomainLevel_ >::create(), FEAT::Control::Domain::PartiDomainControl< DomainLevel_ >::create_rectilinear(), FEAT::Solver::IterationStats::destroy(), FEAT::Global::SynchScalarTicket< DT_ >::wait(), and FEAT::Global::SynchVectorTicket< VT_, VMT_ >::wait().

◆ elapsed_string()

String FEAT::TimeStamp::elapsed_string	(	const TimeStamp &	before,
		TimeFormat	format = `TimeFormat::s_m`
	)		const

inline

Return the time elapsed between two time stamps as a string.

See TimeStamp::format_micros() for more information about the formatting options.

Parameters

[in]	before	A time stamp that represents a previous moment.
[in]	format	Specifies string formatting to be used.

Returns: The time elapsed between the time stamps before and this as a formatted string, for example h:mm:ss.mm.

Definition at line 253 of file time_stamp.hpp.

References elapsed_micros(), and format_micros().

◆ elapsed_string_now()

String FEAT::TimeStamp::elapsed_string_now ( TimeFormat format = TimeFormat::s_m ) const

inline

Calculates the time elapsed between the time stamp and now as a string.

Note: This function does not update (stamp) this time stamp.

See TimeStamp::format_micros() for more information about the formatting options.

Parameters

[in] format Specifies string formatting to be used.

Returns: The time elapsed between this time stamp and now as a formatted string, for example h:mm:ss.mm.

Definition at line 273 of file time_stamp.hpp.

References TimeStamp().

◆ format_micros()

static String FEAT::TimeStamp::format_micros	(	long long	micros,
		TimeFormat	format = `TimeFormat::s_m`
	)

inlinestatic

Formats an elapsed time in microseconds as a string.

This function formats the given elapsed time as a string, where the format depends on the TimeFormat parameter:

For TimeFormat::h_m_s_m the string is of the format h:mm:ss.mmm.
For TimeFormat::h_m_s the string is of the format h:mm:ss.
For TimeFormat::m_s_m the string is of the format m:ss.mmm.
For TimeFormat::m_s the string is of the format m:ss.
For TimeFormat::s_m the string is of the format s.mmm.

Parameters

[in]	micros	The elapsed time to be formatted.
[in]	format	Specifies string formatting to be used.

Returns: The time elapsed as a formatted string, for example h:m:ss.mmm.

Definition at line 187 of file time_stamp.hpp.

References FEAT::h_m_s, FEAT::h_m_s_m, FEAT::m_s, FEAT::m_s_m, FEAT::s_m, and XABORTM.

Referenced by elapsed_string(), and FEAT::StopWatch::elapsed_string().

◆ operator<()

bool FEAT::TimeStamp::operator< ( const TimeStamp & other ) const

inline

Comparison operator.

Parameters

[in] other Another time-stamp.

Returns: true, if this time-stamp has been taken earlier than other, otherwise false.

Definition at line 287 of file time_stamp.hpp.

References _clock.

◆ stamp()

TimeStamp & FEAT::TimeStamp::stamp ( )

inline

Stamps the current time-stamp.

This function updates the time-stamp to the current time.

Returns: *this

Definition at line 79 of file time_stamp.hpp.

References _clock, and FEAT::Windows::query_performance_counter().

Referenced by FEAT::Geometry::PartiIterative< ConformalMesh< Shape_, num_coords_, Coord_ > >::PartiIterative(), TimeStamp(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_colored(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_layered(), FEAT::Assembly::DomainAssembler< Trafo_ >::Worker< Job_ >::_work_no_scatter(), FEAT::StopWatch::start(), and FEAT::StopWatch::stop().

Member Data Documentation

◆ _clock

clock_t FEAT::TimeStamp::_clock

private

Our time-stamp.

Definition at line 62 of file time_stamp.hpp.

Referenced by elapsed(), elapsed_micros(), operator<(), and stamp().

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

kernel/util/time_stamp.hpp

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TimeStamp()

Member Function Documentation

◆ elapsed()

◆ elapsed_micros()

◆ elapsed_micros_now()

◆ elapsed_now()

◆ elapsed_string()

◆ elapsed_string_now()

◆ format_micros()

◆ operator<()

◆ stamp()

Member Data Documentation

◆ _clock