PFunctionPerf Class Reference

Performances of a function. More...

#include <PFunctionPerf.h>

Public Member Functions
const std::string &	getName () const
	Get the name of the function to profile.
void	getPerf (size_t &nbCall, double &fullTime, double &averageTime, double &stdTime, size_t &minTime, size_t &maxTime) const
	Get the performances of the current function.
PFunctionPerf &	operator= (const PFunctionPerf &other)
	Definition of equal operator of PFunctionPerf.
	PFunctionPerf (const PFunctionPerf &other)
	Copy constructor of PFunctionPerf.
	PFunctionPerf (const std::string &name="")
	Default constructor of PFunctionPerf.
void	print (std::ostream &out=std::cout) const
	Print the performance of the function.
void	printCsv (std::ostream &out=std::cout) const
	Print the performance of the function in CSV format.
void	reset ()
	Reset the profiling.
void	reset (size_t threadIndex)
	Reset the profiling.
void	resize (size_t nbThread)
	Resize the PFunctionPerf by respect to the number of thread which call the function.
void	setName (const std::string &name)
	Set the name of the function profiled by the current PFunctionPerf.
void	start (size_t threadIndex=0lu)
	Start the timing for one function.
void	stop (size_t threadIndex=0lu)
	Stop the timing of one function.
virtual	~PFunctionPerf ()
	Destructor of PFunctionPerf.

Protected Member Functions
void	copyPFunctionPerf (const PFunctionPerf &other)
	Copy function of PFunctionPerf.

Private Member Functions
void	initialisationPFunctionPerf (const std::string &name)
	Initialisation function of the class PFunctionPerf.

Private Attributes
std::vector< double >	p_fullSqrTime
	Sum of all square times (used to compute standard deviation)
std::vector< double >	p_fullTime
	Full time of execution for the current function (compute the averaged time with nbCall)
std::vector< size_t >	p_maxTime
	Maximum execution time.
std::vector< size_t >	p_minTime
	Minimum execution time.
std::string	p_name
	Name of the function to profile.
std::vector< size_t >	p_nbCall
	Number of calls of the current function.
std::vector< size_t >	p_timeBegin
	Begin time of the current performance evaluation.

Detailed Description

Performances of a function.

Definition at line 17 of file PFunctionPerf.h.

Constructor & Destructor Documentation

PFunctionPerf() [1/2]

PFunctionPerf::PFunctionPerf

(

const std::string &

name = ""

)

Default constructor of PFunctionPerf.

Parameters

name	: name of the function to profile

Definition at line 13 of file PFunctionPerf.cpp.

                                                  {
        initialisationPFunctionPerf(name);
}

References initialisationPFunctionPerf().

Referenced by copyPFunctionPerf(), operator=(), and PFunctionPerf().

Here is the call graph for this function:

Here is the caller graph for this function:

PFunctionPerf() [2/2]

PFunctionPerf::PFunctionPerf

(

const PFunctionPerf &

other

)

Copy constructor of PFunctionPerf.

Parameters

other

: class to copy

Definition at line 20 of file PFunctionPerf.cpp.

                                                       {
        copyPFunctionPerf(other);
}

References copyPFunctionPerf(), and PFunctionPerf().

Here is the call graph for this function:

~PFunctionPerf()

PFunctionPerf::~PFunctionPerf ( )

virtual

Destructor of PFunctionPerf.

Definition at line 25 of file PFunctionPerf.cpp.

                             {
        
}

Member Function Documentation

copyPFunctionPerf()

void PFunctionPerf::copyPFunctionPerf ( const PFunctionPerf & other )

protected

Copy function of PFunctionPerf.

Parameters

other

: class to copy

Definition at line 167 of file PFunctionPerf.cpp.

                                                                {
        p_name = other.p_name;
        p_timeBegin = other.p_timeBegin;
        p_nbCall = other.p_nbCall;
        p_fullTime = other.p_fullTime;
        p_fullSqrTime = other.p_fullSqrTime;
        p_minTime = other.p_minTime;
        p_maxTime = other.p_maxTime;
}

References p_fullSqrTime, p_fullTime, p_maxTime, p_minTime, p_name, p_nbCall, p_timeBegin, and PFunctionPerf().

Referenced by operator=(), and PFunctionPerf().

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

const std::string & PFunctionPerf::getName

(

)

const

Get the name of the function to profile.

Returns

name of the function to profile

Definition at line 138 of file PFunctionPerf.cpp.

                                              {
        return p_name;
}

References p_name.

getPerf()

void PFunctionPerf::getPerf	(	size_t &	nbCall,
		double &	fullTime,
		double &	averageTime,
		double &	stdTime,
		size_t &	minTime,
		size_t &	maxTime ) const

Get the performances of the current function.

Parameters

[out]	nbCall	: number of time this function was called
[out]	fullTime	: total time of all function calls
[out]	averageTime	: average time of one function calls
[out]	stdTime	: standard deviation between all function calls (if nbCall is small this result can be unrelevant)
[out]	minTime	: minimum time of a single execution
[out]	maxTime	: maximum time of a single execution

Definition at line 118 of file PFunctionPerf.cpp.

                                                                                                                                               {
        nbCall = reduceVectorVale(p_nbCall);
        if(nbCall != 0lu){
                fullTime = reduceVectorVale(p_fullTime);
                averageTime = fullTime/((double)nbCall);
                stdTime = sqrt((reduceVectorVale(p_fullSqrTime)/((double)nbCall)) - (averageTime*averageTime));
                minTime = reduceVectorVale(p_minTime)*0.5;
                maxTime = reduceVectorVale(p_maxTime)*0.5;
        }else{
                fullTime = 0.0;
                averageTime = 0.0;
                stdTime = 0.0;
                minTime = 0.0;
                maxTime = 0.0;
        }
}

References p_fullSqrTime, p_fullTime, p_maxTime, p_minTime, p_nbCall, and reduceVectorVale().

Referenced by print(), and printCsv().

Here is the call graph for this function:

Here is the caller graph for this function:

initialisationPFunctionPerf()

void PFunctionPerf::initialisationPFunctionPerf ( const std::string & name )

private

Initialisation function of the class PFunctionPerf.

Parameters

name	: name of the function to profile

Definition at line 180 of file PFunctionPerf.cpp.

                                                                     {
        p_name = name;
        resize(1lu);
}

References p_name, and resize().

Referenced by PFunctionPerf().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

PFunctionPerf & PFunctionPerf::operator=

(

const PFunctionPerf &

other

)

Definition of equal operator of PFunctionPerf.

Parameters

other

: class to copy

Returns

copied class

Definition at line 33 of file PFunctionPerf.cpp.

                                                                     {
        copyPFunctionPerf(other);
        return *this;
}

References copyPFunctionPerf(), and PFunctionPerf().

Here is the call graph for this function:

print()

void PFunctionPerf::print

(

std::ostream &

out = std::cout

)

const

Print the performance of the function.

Parameters

[out]

out : ostream to be used

Definition at line 145 of file PFunctionPerf.cpp.

                                               {
        size_t nbCall(0lu);
        double fullTime(0.0), averageTime(0.0), stdTime(0.0);
        size_t minTime(0lu), maxTime(0lu);
        getPerf(nbCall, fullTime, averageTime, stdTime, minTime, maxTime);
        out << "Function "<<p_name<<"(nbCall = " << nbCall << ", fullTime = " << fullTime << " cy, averageTime = " << averageTime << " cy, stdTime = " << stdTime << " cy, minTime = " << minTime << " cy, maxTime = " << maxTime << " cy)" << std::endl;
}

References getPerf(), and p_name.

Here is the call graph for this function:

printCsv()

void PFunctionPerf::printCsv

(

std::ostream &

out = std::cout

)

const

Print the performance of the function in CSV format.

Parameters

[out]

out : ostream to be used

Definition at line 156 of file PFunctionPerf.cpp.

                                                  {
        size_t nbCall(0lu);
        double fullTime(0.0), averageTime(0.0), stdTime(0.0);
        size_t minTime(0lu), maxTime(0lu);
        getPerf(nbCall, fullTime, averageTime, stdTime, minTime, maxTime);
        out <<p_name<<"," << nbCall << "," << fullTime << "," << averageTime << "," << stdTime << "," << minTime << "," << maxTime << std::endl;
}

References getPerf(), and p_name.

Here is the call graph for this function:

reset() [1/2]

void PFunctionPerf::reset

(

)

Reset the profiling.

Definition at line 91 of file PFunctionPerf.cpp.

                         {
        for(size_t i(0lu); i < p_timeBegin.size(); ++i){
                reset(i);
        }
}

References p_timeBegin, and reset().

Referenced by reset(), and resize().

Here is the call graph for this function:

Here is the caller graph for this function:

reset() [2/2]

void PFunctionPerf::reset

(

size_t

threadIndex

)

Reset the profiling.

Parameters

threadIndex

: index of the current thread to be measured

Definition at line 81 of file PFunctionPerf.cpp.

                                           {
        p_timeBegin[threadIndex] = 0lu;
        p_nbCall[threadIndex] = 0lu;
        p_fullTime[threadIndex] = 0.0;
        p_fullSqrTime[threadIndex] = 0.0;
        p_minTime[threadIndex] = -1lu;
        p_maxTime[threadIndex] = 0lu;
}

References p_fullSqrTime, p_fullTime, p_maxTime, p_minTime, p_nbCall, and p_timeBegin.

resize()

void PFunctionPerf::resize

(

size_t

nbThread

)

Resize the PFunctionPerf by respect to the number of thread which call the function.

Parameters

nbThread

: number of threads which call the function

Definition at line 48 of file PFunctionPerf.cpp.

                                         {
        p_timeBegin.resize(nbThread);
        p_nbCall.resize(nbThread);
        p_fullTime.resize(nbThread);
        p_fullSqrTime.resize(nbThread);
        p_minTime.resize(nbThread);
        p_maxTime.resize(nbThread);
        reset();
}

References p_fullSqrTime, p_fullTime, p_maxTime, p_minTime, p_nbCall, p_timeBegin, and reset().

Referenced by PProfiler::addFunction(), and initialisationPFunctionPerf().

Here is the call graph for this function:

Here is the caller graph for this function:

setName()

void PFunctionPerf::setName

(

const std::string &

name

)

Set the name of the function profiled by the current PFunctionPerf.

Parameters

name	: name of the function to profile

Definition at line 41 of file PFunctionPerf.cpp.

                                                 {
        p_name = name;
}

References p_name.

start()

void PFunctionPerf::start

(

size_t

threadIndex = 0lu

)

Start the timing for one function.

Parameters

threadIndex

: index of the current thread to be measured

Definition at line 61 of file PFunctionPerf.cpp.

                                           {
        p_timeBegin[threadIndex] = phoenix_hardware_rdtsc();
}

References p_timeBegin.

stop()

void PFunctionPerf::stop

(

size_t

threadIndex = 0lu

)

Stop the timing of one function.

Parameters

threadIndex

: index of the current thread to be measured

Definition at line 68 of file PFunctionPerf.cpp.

                                          {
        size_t elapsedTime = phoenix_hardware_rdtsc() - p_timeBegin[threadIndex];
        double dTime = elapsedTime;
        p_fullTime[threadIndex] += dTime;
        p_fullSqrTime[threadIndex] += dTime*dTime;
        if(elapsedTime > p_maxTime[threadIndex]){p_maxTime[threadIndex] = elapsedTime;}
        if(elapsedTime < p_minTime[threadIndex]){p_minTime[threadIndex] = elapsedTime;}
        ++(p_nbCall[threadIndex]);
}

References p_fullSqrTime, p_fullTime, p_maxTime, p_minTime, p_nbCall, and p_timeBegin.

Member Data Documentation

p_fullSqrTime

std::vector<double> PFunctionPerf::p_fullSqrTime

private

Sum of all square times (used to compute standard deviation)

Definition at line 53 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), getPerf(), reset(), resize(), and stop().

p_fullTime

std::vector<double> PFunctionPerf::p_fullTime

private

Full time of execution for the current function (compute the averaged time with nbCall)

Definition at line 51 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), getPerf(), reset(), resize(), and stop().

p_maxTime

std::vector<size_t> PFunctionPerf::p_maxTime

private

Maximum execution time.

Definition at line 57 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), getPerf(), reset(), resize(), and stop().

p_minTime

std::vector<size_t> PFunctionPerf::p_minTime

private

Minimum execution time.

Definition at line 55 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), getPerf(), reset(), resize(), and stop().

p_name

std::string PFunctionPerf::p_name

private

Name of the function to profile.

Definition at line 45 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), getName(), initialisationPFunctionPerf(), print(), printCsv(), and setName().

p_nbCall

std::vector<size_t> PFunctionPerf::p_nbCall

private

Number of calls of the current function.

Definition at line 49 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), getPerf(), reset(), resize(), and stop().

p_timeBegin

std::vector<size_t> PFunctionPerf::p_timeBegin

private

Begin time of the current performance evaluation.

Definition at line 47 of file PFunctionPerf.h.

Referenced by copyPFunctionPerf(), reset(), reset(), resize(), start(), and stop().

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/hardware/PhoenixHardware/src/PFunctionPerf.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/hardware/PhoenixHardware/src/PFunctionPerf.cpp