hebench::ReportGen::EventType Class Reference

Extracts and maintains the timing report events of the same type. More...

Public Member Functions
	EventType (const cpp::TimingReport &report, std::uint32_t event_id)
	Constructs an event type from a report. More...
	EventType (const std::vector< double > &cpu_events, const std::vector< double > &wall_events, std::uint32_t event_id, const std::string_view &event_name)
std::uint32_t	getID () const
	ID of the event type. More...
const std::string &	getName () const
	Name of the event type as per the report. More...
const std::vector< double > &	getCPUEvents () const
	Collection of contained CPU-timed events of the same type extracted from the report. More...
const std::vector< double > &	getWallEvents () const
	Collection of contained wall-timed events of the same type extracted from the report. More...
void	computeStats (ReportEventTypeStats &result) const
	Computes statistics for this event type based on the contained events. More...
ReportEventTypeStats	computeStats () const
	Computes statistics for this event type based on the contained events. More...

Detailed Description

Extracts and maintains the timing report events of the same type.

Maintains a collection of timing report events of the same type extracted from a report. The events' timings are converted to elapsed times in seconds.

Definition at line 60 of file hebench_report_stats.cpp.

Constructor & Destructor Documentation

EventType() [1/2]

hebench::ReportGen::EventType::EventType	(	const cpp::TimingReport &	report,
		std::uint32_t	event_id
	)

Constructs an event type from a report.

Parameters

[in]	report	Report from which to extract the events.
[in]	event_id	ID of type of event to extract.

Definition at line 116 of file hebench_report_stats.cpp.

EventType() [2/2]

hebench::ReportGen::EventType::EventType	(	const std::vector< double > &	cpu_events,
		const std::vector< double > &	wall_events,
		std::uint32_t	event_id,
		const std::string_view &	event_name
	)

Definition at line 161 of file hebench_report_stats.cpp.

Member Function Documentation

computeStats() [1/2]

ReportEventTypeStats hebench::ReportGen::EventType::computeStats ( ) const

inline

Computes statistics for this event type based on the contained events.

Returns

An instance of ReportEventTypeStats containing the statistical computation results.

All timings for the stats are in seconds.

Definition at line 102 of file hebench_report_stats.cpp.

computeStats() [2/2]

void hebench::ReportGen::EventType::computeStats

(

ReportEventTypeStats &

result

)

const

Computes statistics for this event type based on the contained events.

Parameters

[out]

result

ReportEventTypeStats to receive the statistical computation results.

All timings for the stats are in seconds.

Definition at line 173 of file hebench_report_stats.cpp.

getCPUEvents()

const std::vector<double>& hebench::ReportGen::EventType::getCPUEvents ( ) const

inline

Collection of contained CPU-timed events of the same type extracted from the report.

Definition at line 83 of file hebench_report_stats.cpp.

getID()

std::uint32_t hebench::ReportGen::EventType::getID ( ) const

inline

ID of the event type.

Definition at line 75 of file hebench_report_stats.cpp.

getName()

const std::string& hebench::ReportGen::EventType::getName ( ) const

inline

Name of the event type as per the report.

Definition at line 79 of file hebench_report_stats.cpp.

getWallEvents()

const std::vector<double>& hebench::ReportGen::EventType::getWallEvents ( ) const

inline

Collection of contained wall-timed events of the same type extracted from the report.

Definition at line 87 of file hebench_report_stats.cpp.

---

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

• hebench_report_stats.cpp