instrumentedPhase Class Reference
[Automatic Performance Tuning and Steering Framework]

Stores data for a phase (a time range in which a single set of control point values is used). More...

#include <controlPoints.h>

Collaboration diagram for instrumentedPhase:

[legend]

Public Member Functions
	instrumentedPhase ()
void	clear ()
bool	haveValueForName (const char *name)
void	operator= (const instrumentedPhase &p)
bool	operator< (const instrumentedPhase &p)
bool	hasValidControlPointValues ()
bool	operator== (const instrumentedPhase &p)
bool	hasSameKeysAs (const instrumentedPhase &p)
	Verify the names of the control points are consistent note: std::map stores the pairs in a sorted order based on their first component.
void	addAllNames (std::set< std::string > names_)
void	print () const
double	medianTime ()
	Determine the median time for this phase.
Data Fields
std::map< std::string, int >	controlPoints
std::vector< double >	times
std::vector < PathHistoryTableEntry >	criticalPaths
double	memoryUsageMB
idleTimeContainer	idleTime
overheadContainer	overheadTime
double	bytesPerInvoke
	Approximately records the average message size for an entry method.
double	grainSize
	Records the average grain size (might be off a bit due to non application entry methods), in seconds.

---

Detailed Description

Stores data for a phase (a time range in which a single set of control point values is used).

The data stored includes the control point values, a set of timings registered by the application, The critical paths detected, the max memory usage, and the idle time.

Definition at line 179 of file controlPoints.h.

---

Constructor & Destructor Documentation

instrumentedPhase::instrumentedPhase

(

)

[inline]

Definition at line 201 of file controlPoints.h.

References bytesPerInvoke, grainSize, and memoryUsageMB.

---

Member Function Documentation

void instrumentedPhase::clear

(

)

[inline]

Definition at line 207 of file controlPoints.h.

References bytesPerInvoke, controlPoints, grainSize, memoryUsageMB, and times.

bool instrumentedPhase::haveValueForName

(

const char *

name

)

[inline]

Definition at line 217 of file controlPoints.h.

References controlPoints, and n.

void instrumentedPhase::operator=

(

const instrumentedPhase &

p

)

[inline]

Definition at line 222 of file controlPoints.h.

References controlPoints, memoryUsageMB, and times.

bool instrumentedPhase::operator<

(

const instrumentedPhase &

p

)

[inline]

Definition at line 230 of file controlPoints.h.

References controlPoints, and hasSameKeysAs().

Here is the call graph for this function:

bool instrumentedPhase::hasValidControlPointValues

(

)

[inline]

Definition at line 244 of file controlPoints.h.

References controlPoints.

bool instrumentedPhase::operator==

(

const instrumentedPhase &

p

)

[inline]

Definition at line 284 of file controlPoints.h.

References controlPoints, and hasSameKeysAs().

Here is the call graph for this function:

bool instrumentedPhase::hasSameKeysAs

(

const instrumentedPhase &

p

)

[inline]

Verify the names of the control points are consistent note: std::map stores the pairs in a sorted order based on their first component.

Definition at line 298 of file controlPoints.h.

References controlPoints.

Referenced by operator<(), operator==(), and instrumentedData::verify().

Here is the caller graph for this function:

void instrumentedPhase::addAllNames

(

std::set< std::string >

names_

)

[inline]

Definition at line 315 of file controlPoints.h.

References controlPoints.

void instrumentedPhase::print

(

void

)

const [inline]

Definition at line 337 of file controlPoints.h.

References controlPoints, and name.

Referenced by controlPointManager::generatePlan().

Here is the caller graph for this function:

double instrumentedPhase::medianTime

(

)

[inline]

Determine the median time for this phase.

Definition at line 353 of file controlPoints.h.

References sort(), and times.

Here is the call graph for this function:

---

Field Documentation

std::map<std::string,int> instrumentedPhase::controlPoints

Definition at line 181 of file controlPoints.h.

Referenced by addAllNames(), clear(), controlPoint(), simplexScheme::doReflection(), controlPointManager::generatePlan(), hasSameKeysAs(), hasValidControlPointValues(), haveValueForName(), controlPointManager::loadDataFile(), operator<(), operator=(), operator==(), print(), and controlPointManager::processControlPoints().

std::vector<double> instrumentedPhase::times

Definition at line 182 of file controlPoints.h.

Referenced by clear(), controlPointManager::generatePlan(), controlPointManager::loadDataFile(), medianTime(), operator=(), controlPointManager::processControlPoints(), and controlPointManager::setTiming().

std::vector<PathHistoryTableEntry> instrumentedPhase::criticalPaths

Definition at line 185 of file controlPoints.h.

Referenced by controlPointManager::processControlPoints().

double instrumentedPhase::memoryUsageMB

Definition at line 188 of file controlPoints.h.

Referenced by clear(), controlPointManager::gatherAll(), controlPointManager::gatherMemoryUsage(), controlPointManager::generatePlan(), instrumentedPhase(), controlPointManager::loadDataFile(), and operator=().

idleTimeContainer instrumentedPhase::idleTime

Definition at line 190 of file controlPoints.h.

Referenced by controlPointManager::gatherAll(), controlPointManager::gatherIdleTime(), controlPointManager::generatePlan(), controlPointManager::loadDataFile(), and controlPointManager::processControlPoints().

overheadContainer instrumentedPhase::overheadTime

Definition at line 191 of file controlPoints.h.

Referenced by controlPointManager::gatherAll(), controlPointManager::generatePlan(), and controlPointManager::loadDataFile().

double instrumentedPhase::bytesPerInvoke

Approximately records the average message size for an entry method.

Definition at line 195 of file controlPoints.h.

Referenced by clear(), controlPointManager::gatherAll(), instrumentedPhase(), and controlPointManager::loadDataFile().

double instrumentedPhase::grainSize

Records the average grain size (might be off a bit due to non application entry methods), in seconds.

Definition at line 198 of file controlPoints.h.

Referenced by clear(), controlPointManager::gatherAll(), instrumentedPhase(), and controlPointManager::loadDataFile().

---

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

• ck-cp/controlPoints.h