summary_run_metric Class Reference

#include <summary_run_metric.h>

Inheritance diagram for summary_run_metric:

Public Types
enum	{ TYPE = constants::SummaryRun, LATEST_VERSION = 1 }
typedef metric_base::base_metric_header	header_type
typedef std::vector< float >	float_vector
typedef uint8_t	ubyte_t
typedef uint16_t	ushort_t
typedef uint32_t	uint_t
typedef double	count_t
Public Types inherited from empty_metric
typedef ::uint32_t	id_t
typedef ::uint32_t	uint_t
typedef constants::base_run_t	base_t

Public Member Functions
	summary_run_metric ()
	summary_run_metric (const header_type &)
	summary_run_metric (const count_t occupancy_proxy_cluster_count, const count_t raw_cluster_count, const count_t occupied_cluster_count, const count_t pf_cluster_count)
void	set (const count_t occupancy_proxy_cluster_count, const count_t raw_cluster_count, const count_t occupied_cluster_count, const count_t pf_cluster_count)
count_t	raw_cluster_count () const
count_t	occupied_cluster_count () const
count_t	pf_cluster_count () const
count_t	occupancy_proxy_cluster_count () const
count_t	percent_occupancy_proxy () const
count_t	percent_pf () const
count_t	percent_occupied () const
id_t	id () const
Public Member Functions inherited from empty_metric
template<class BaseMetric >
void	set_base (const BaseMetric &)
void	set_base (const uint_t, const uint_t)
bool	operator< (const empty_metric &) const

Static Public Member Functions
static const char *	prefix ()
static count_t	missing ()
Static Public Member Functions inherited from empty_metric
static const char *	suffix ()
static id_t	create_id (const id_t, const id_t, const id_t=0)

Friends
template<class MetricType , int Version>
struct	io::generic_layout

Detailed Description

Summary run metric

The summary run metric contains run-level summary information

Note

Supported versions: 1

Test:

Confirm version 1 of the metric can be written to and read from a stream

Confirm version 1 of the metric matches known binary file

Member Typedef Documentation

typedef double count_t

Count type

typedef std::vector<float> float_vector

Vector of floats

typedef metric_base::base_metric_header header_type

Static run metric header

typedef uint8_t ubyte_t

ubyte_t type

typedef uint32_t uint_t

uint_t type

typedef uint16_t ushort_t

ushort_t type

Member Enumeration Documentation

anonymous enum

Enumerator
TYPE	Unique type code for metric
LATEST_VERSION	Latest version of the InterOp format

Constructor & Destructor Documentation

summary_run_metric ( )

inline

Constructor

summary_run_metric ( const header_type &  )

inline

Constructor

summary_run_metric ( const count_t  occupancy_proxy_cluster_count, const count_t  raw_cluster_count, const count_t  occupied_cluster_count, const count_t  pf_cluster_count  )

inline

Constructor

Note

Version 1

Parameters

occupancy_proxy_cluster_count	proxy for occupancy
raw_cluster_count	raw cluster count
occupied_cluster_count	occupied cluster count
pf_cluster_count	pf cluster count

Member Function Documentation

id_t id ( ) const

inline

Unique id created from both the lane and tile

Returns

unique identifier

static count_t missing ( )

inlinestatic

Flag if value is missing

Returns

missing sentinel

static const char* prefix ( )

inlinestatic

Get the prefix of the InterOp filename

Returns

prefix

void set ( const count_t  occupancy_proxy_cluster_count, const count_t  raw_cluster_count, const count_t  occupied_cluster_count, const count_t  pf_cluster_count  )

inline

Setter

Note

Version 1

Parameters

occupancy_proxy_cluster_count	proxy for occupancy
raw_cluster_count	raw cluster count
occupied_cluster_count	occupied cluster count
pf_cluster_count	pf cluster count

Friends And Related Function Documentation

friend struct io::generic_layout

friend

---

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

• /io/interop/model/metrics/summary_run_metric.h