minlca::MinLCAProfiler< LCA > Class Template Reference

Class for timing MinLCA algorithms. More...

#include <profiler.hh>

Inheritance diagram for minlca::MinLCAProfiler< LCA >:

Collaboration diagram for minlca::MinLCAProfiler< LCA >:

Public Member Functions
template<typename... Args>
	MinLCAProfiler (Args &&...args)
	Constructor. More...
template<typename... Args>
void	init (Args &&...args)
	Reset the data structures of the algorithm. More...
virtual MinLCAStatus	run ()
	Run the algorithm. More...
double	runTime ()
	Retrieve the duration of running the algorithm. More...
double	initTime ()
	Retrieve the duration of initialising the algorithm. More...
double	creationTime ()
	Retrieve the duration of instantiating the algorithm class. More...

Protected Types
typedef LCA	Base

Protected Attributes
utils::Timer	_t
	Timer used to count the durations.
double	_creation_time
	Duration of object creation.
double	_init_time
	Duration of algorithm initialisation.
double	_run_time
	Duration of algorithm running.

Detailed Description

template<class LCA>
class minlca::MinLCAProfiler< LCA >

Class for timing MinLCA algorithms.

Definition at line 16 of file profiler.hh.

Constructor & Destructor Documentation

template<class LCA>

template<typename... Args>

minlca::MinLCAProfiler< LCA >::MinLCAProfiler ( Args &&...  args )

inline

Constructor.

Parameters

args	Arguments for the constructor. They depend on the LCA class.

Definition at line 28 of file profiler.hh.

Member Function Documentation

template<class LCA>

double minlca::MinLCAProfiler< LCA >::creationTime ( )

inline

Retrieve the duration of instantiating the algorithm class.

Returns

The duration of instantiating the algorithm class

Definition at line 78 of file profiler.hh.

template<class LCA>

template<typename... Args>

void minlca::MinLCAProfiler< LCA >::init ( Args &&...  args )

inline

Reset the data structures of the algorithm.

Resets the data structures of the algorithm. Must be called before its execution with run().

See also

run()

Parameters

args	Arguments for the constructor. They depend on the LCA class.

Definition at line 39 of file profiler.hh.

template<class LCA>

double minlca::MinLCAProfiler< LCA >::initTime ( )

inline

Retrieve the duration of initialising the algorithm.

Returns

The duration of initialising the algorithm

Definition at line 70 of file profiler.hh.

template<class LCA>

virtual MinLCAStatus minlca::MinLCAProfiler< LCA >::run ( )

inlinevirtual

Run the algorithm.

Runs the algorithm and returns its status. Need to call init() before executing.

Returns

Status of the solution

See also

init()

Definition at line 50 of file profiler.hh.

template<class LCA>

double minlca::MinLCAProfiler< LCA >::runTime ( )

inline

Retrieve the duration of running the algorithm.

Returns

The duration of running the algorithm

Definition at line 62 of file profiler.hh.

---

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

• minlca/profiler.hh