skepu::TuneData< Tx, Ty > Class Template Reference

A class that can be used to collect tuning data. More...

#include <data_tune.h>

Public Member Functions
	TuneData (const std::string &_dataSetName, const std::string &_axisNameX, const std::string &_axisNameY)
void	addData (Tx x, TuneParams< Ty > params, int repetition=1)
void	clear ()
void	writeDataToFile (const std::string &filename="", int repeatition=1, DataExportFormat format=GNUPLOT)
void	loadPrediction (const std::string &filename, int repetition=1)

Detailed Description

template<typename Tx, typename Ty>
class skepu::TuneData< Tx, Ty >

A class that can be used to collect tuning data.

This class is used to simplify the collection of two dimensional data. It stores the data internally in a multiset of pairs. It can then be outputted in various formats. In the current version it only supports outputting to a file readable by GnuPlot.

Constructor & Destructor Documentation

template<typename Tx , typename Ty >

skepu::TuneData< Tx, Ty >::TuneData	(	const std::string &	_dataSetName,
		const std::string &	_axisNameX,
		const std::string &	_axisNameY
	)

The constructor sets some names for the current dataset.

Parameters

_dataSetName	Name of the dataset.
_axisNameX	Name of the X axis data, or rather the first data.
_axisNameY	Name of the Y axis data, or the second data.

Member Function Documentation

template<typename Tx , typename Ty >

void skepu::TuneData< Tx, Ty >::addData	(	Tx	size,
		TuneParams< Ty >	params,
		int	repetition = 1
	)

Adds a 2D data point to the dataset.

Parameters

x	x coordinate.
y	y coordinate.

template<typename Tx , typename Ty >

void skepu::TuneData< Tx, Ty >::clear

(

)

Clear the entire data set.

template<typename Tx , typename Ty >

void skepu::TuneData< Tx, Ty >::loadPrediction	(	const std::string &	filename,
		int	repetition = 1
	)

Load data from a prediction file.

Parameters

filename

Filename of the source data file.

template<typename Tx , typename Ty >

void skepu::TuneData< Tx, Ty >::writeDataToFile	(	const std::string &	filename = "",
		int	repeatition = 1,
		DataExportFormat	format = GNUPLOT
	)

Write the data to a file.

Parameters

filename	Filename of the data file to write to.
format	Format of the data. Currently only GNUPLOT.

---

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

• include/skepu/src/unused_files/data_tune.h