#include <perfstats.hpp>

Public Member Functions
double	meanIter (const size_t iter)
	Functions to summarise data of one iteration. More...

double	lastIter (const size_t iter)
	Provide the last value of the stats data of a given iteration. More...

double	minIter (const size_t iter)
	Compute the minimum value of the stats data of a given iteration. More...

double	maxIter (const size_t iter)
	Compute the maximum value of the stats data of a given iteration. More...

double	sumIter (const size_t iter)
	Compute the sum value of the stats data of a given iteration. More...

double	mergeIter (const size_t iter)
	Merge the stats data a given interation into a scalar value. More...

double	mean () const
	Functions to summarise data of the entire stats. More...

double	last () const
	Provide the last stored value to the stats data. More...

double	min () const
	Compute the minimum value of all stats data stored so far. More...

double	max () const
	Compute the maximum value of all stats data stored so far. More...

double	sum () const
	Compute the sum of all stats data stored so far. More...

double	merge () const
	Merge all stats data into a scalar value. More...

std::string	unitString ()

Static Public Member Functions
static double	meanIter (const std::vector< double > &iter_data_vec)
	Static functions to summarise data of one iteration. More...

static double	lastIter (const std::vector< double > &iter_data_vec)
	Provide the last value of the stats data of an iteration. More...

static double	minIter (const std::vector< double > &iter_data_vec)
	Compute the minimum value of the stats data of an iteration. More...

static double	maxIter (const std::vector< double > &iter_data_vec)
	Compute the maximum value of the stats data of an iteration. More...

static double	sumIter (const std::vector< double > &iter_data_vec)
	Compute the sum of the values of the stats data of an iteration. More...

static double	mergeIter (const std::vector< double > &iter_data_vec, const Type type)
	Merge the stats data of one interation into a scalar value. More...

Public Attributes
std::map< size_t, std::vector< double > >	data_

bool	detailed_
	Flag indicating if the stat should be excluded from basic string output. More...

double	last_absolute_
	The last absolute time the stat data was updated. More...

std::mutex	mutex_

Type	type_
	The type of data stored in the stat struct. More...

Member Function Documentation

◆ meanIter() [1/2]

static double PerfStats::Stats::meanIter ( const std::vector< double > & iter_data_vec )

static

Static functions to summarise data of one iteration.

Compute the mean value of the stats data of an iteration.

Parameters

[in] iter_data_vec The vector containing all values to be processed.

Returns: The mean of the values in the iter_data_vec.

◆ lastIter() [1/2]

static double PerfStats::Stats::lastIter ( const std::vector< double > & iter_data_vec )

static

Provide the last value of the stats data of an iteration.

Parameters

[in] iter_data_vec The vector containing all values to be processed.

Returns: The last value in the iter_data_vec.

◆ minIter() [1/2]

static double PerfStats::Stats::minIter ( const std::vector< double > & iter_data_vec )

static

Compute the minimum value of the stats data of an iteration.

Parameters

[in] iter_data_vec The vector containing all values to be processed.

Returns: The minimum value of the values in the iter_data_vec.

◆ maxIter() [1/2]

static double PerfStats::Stats::maxIter ( const std::vector< double > & iter_data_vec )

static

Compute the maximum value of the stats data of an iteration.

Parameters

[in] iter_data_vec The vector containing all values to be processed.

Returns: The maximum value of the values in the iter_data_vec.

◆ sumIter() [1/2]

static double PerfStats::Stats::sumIter ( const std::vector< double > & iter_data_vec )

static

Compute the sum of the values of the stats data of an iteration.

Parameters

[in] iter_data_vec The vector containing all values to be processed.

Returns: The sum of the values in the iter_data_vec.

◆ mergeIter() [1/2]

static double PerfStats::Stats::mergeIter	(	const std::vector< double > &	iter_data_vec,
		const Type	type
	)

static

Merge the stats data of one interation into a scalar value.

The merging strategy depends on the PerfStats::Type.

Parameters

[in] iter_data_vec The vector containing all values to be processed.

Returns: The merged scalar value of the values in the iter_data_vec.

◆ meanIter() [2/2]

double PerfStats::Stats::meanIter ( const size_t iter )

Functions to summarise data of one iteration.

Compute the mean value of the stats data of a given iteration.

Parameters

[in] iter The iteration to processed.

Returns: The mean of the values of the given iteration.

◆ lastIter() [2/2]

double PerfStats::Stats::lastIter ( const size_t iter )

Provide the last value of the stats data of a given iteration.

Parameters

[in] iter The iteration to processed.

Returns: The last value of the given iteration.

◆ minIter() [2/2]

double PerfStats::Stats::minIter ( const size_t iter )

Compute the minimum value of the stats data of a given iteration.

Parameters

[in] iter The iteration to processed.

Returns: The minimum value of the given iteration.

◆ maxIter() [2/2]

double PerfStats::Stats::maxIter ( const size_t iter )

Compute the maximum value of the stats data of a given iteration.

Parameters

[in] iter The iteration to processed.

Returns: The maximum value of the given iteration.

◆ sumIter() [2/2]

double PerfStats::Stats::sumIter ( const size_t iter )

Compute the sum value of the stats data of a given iteration.

Parameters

[in] iter The iteration to processed.

Returns: The sum of the values of the given iteration.

◆ mergeIter() [2/2]

double PerfStats::Stats::mergeIter ( const size_t iter )

Merge the stats data a given interation into a scalar value.

The merging strategy depends on the PerfStats::Type.

Parameters

[in] iter The iteration to processed.

Returns: The merged scalar value of the values of the given iteration.

◆ mean()

double PerfStats::Stats::mean ( ) const

Functions to summarise data of the entire stats.

Compute the mean value of all stats data stored so far.

Returns: The mean of all stats data

◆ last()

double PerfStats::Stats::last ( ) const

Provide the last stored value to the stats data.

Returns: The last value of the stats data

◆ min()

double PerfStats::Stats::min ( ) const

Compute the minimum value of all stats data stored so far.

Returns: The minimum value of all stats data.

◆ max()

double PerfStats::Stats::max ( ) const

Compute the maximum value of all stats data stored so far.

Returns: The maximum value of all stats data.

◆ sum()

double PerfStats::Stats::sum ( ) const

Compute the sum of all stats data stored so far.

Returns: The sum of all stats data.

◆ merge()

double PerfStats::Stats::merge ( ) const

Merge all stats data into a scalar value.

The merging strategy depends on the PerfStats::Type.

Returns: The merged scalar value of all stats data.

◆ unitString()

std::string PerfStats::Stats::unitString ( )

Returns: The unit of the stats type as a std::string, e.g. "[V]" for PerfStats::Voltage.

Member Data Documentation

◆ data_

std::map<size_t, std::vector<double> > PerfStats::Stats::data_

◆ detailed_

bool PerfStats::Stats::detailed_

Flag indicating if the stat should be excluded from basic string output.

◆ last_absolute_

double PerfStats::Stats::last_absolute_

The last absolute time the stat data was updated.

◆ mutex_

std::mutex PerfStats::Stats::mutex_

◆ type_

Type PerfStats::Stats::type_

The type of data stored in the stat struct.

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

include/se/common/perfstats.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Member Function Documentation

◆ meanIter() [1/2]

◆ lastIter() [1/2]

◆ minIter() [1/2]

◆ maxIter() [1/2]

◆ sumIter() [1/2]

◆ mergeIter() [1/2]

◆ meanIter() [2/2]

◆ lastIter() [2/2]

◆ minIter() [2/2]

◆ maxIter() [2/2]

◆ sumIter() [2/2]

◆ mergeIter() [2/2]

◆ mean()

◆ last()

◆ min()

◆ max()

◆ sum()

◆ merge()

◆ unitString()

Member Data Documentation

◆ data_

◆ detailed_

◆ last_absolute_

◆ mutex_

◆ type_