The raw data to plot. More...

#include <benchmark.h>

Public Member Functions
const DataSeries &	getSeries (const size_t &i) const
	Returns the ith series of measurements.

const DataSeries &	selectSeries (const size_t &i)
	Returns the ith series of measurements.

const DataSeries &	selectSeries (const std::string &name)
	Returns the series of measurements after its name.

const DataSeries &	getCurrentSeries () const
	Returns the current series of measurements.

DataSeries &	refSeries (const size_t &i)
	Returns the ith series of measurements.

DataSeries &	refSeries (const std::string &nom)
	Returns the ith series of measurements.

DataSeries &	refCurrentSeries ()
	Returns the current series of measurements.

	PlotData ()
	Inits a plot with series of data.

	~PlotData ()
	destructor.

	PlotData (const PlotData &PD)
	copy constructor.

void	clear ()
	initialize to empty

void	merge (const PlotData &PD)
	merges another plot data to the current one.

size_t	size () const
	get the number of series.

size_t	getCurrentSeriesNumber () const
	gets the current series number.

void	setSeriesName (const size_t &i, const std::string &nom)
	Sets the name of a series.

const std::string &	getSeriesName (const size_t &i) const
	Gets the name of a series.

const std::string &	getCurrentSeriesName () const
	Gets the name of the current series.

void	setCurrentSeriesName (const std::string &nom)
	Sets the name of the current series.

void	initWatch (const size_t &i)
	Inits the watch on a series.

void	initCurrentSeriesWatch ()
	Inits the watch to current series.

void	newSeries (const std::string &nom="")
	Creates a new series.

void	finishSeries ()
	Finish a series of measurements.

size_t	getSeriesSize (const size_t &i) const
	size of a series.

size_t	getCurrentSeriesSize () const
	size of the current series.

bool	selectNextSeries ()
	goes to the next series of points

void	selectFirstSeries ()
	selects the first series

template<class T>
void	setSeriesPointLabel (const size_t &i, const size_t &j, const T &nom)
	Sets the name of a point.

void	setCurrentSeriesPointLabel (const size_t &j, const std::string &nom)
	Sets the name of a point.

std::string	getSeriesLabel (const size_t &i) const
	gets the name of a series.

std::string	getCurrentSeriesLabel () const
	gets the name of a series.

const svector_t &	getSeriesLabels () const
	gets all the names in the series.

void	setSeriesEntry (const size_t &i, const std::string &nam, const double &val, const double &xval=NAN, const double &yval=NAN)
	sets a new entry.

void	setSeriesEntry (const std::string &nom, const std::string &nam, const double &val, const double &xval=NAN, const double &yval=NAN)
	sets a new entry.

template<class T>
void	setCurrentSeriesEntry (const T &nam, const double &val, const double &xval=NAN, const double &yval=NAN)
	sets a new entry.

const std::vector< DataSeries > &	getTable () const
	gets a reference to the array of data.

std::vector< DataSeries > &	refTable ()
	gets a reference to the array of data.

bool	keepon (size_t &repet, double tim, bool usePrediction=false)
	Continue for another time measure ?

void	save (const std::string &filename, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	saves the data in XML format.

const std::string &	getCurrentEntryId () const
	returns the unique ID of the current series last entry

const std::string &	getCurrentSeriesId (const size_t &j) const
	returns the unique ID of the current series j'th entry.

const std::string &	getId (const size_t &i, const size_t &j)
	returns the unique ID of the i'th series j'th entry.

const std::string &	getId (const std::string &name, const size_t &j)
	returns the unique ID of the i'th series j'th entry.

Detailed Description

The raw data to plot.

Represents the labels for the points (X axis) and the values for each series of measures (Y axis).

Members that set/get are named as follows :

getX(nom,j) return the j'th element of series named nom
getX(i,j) return the j'th element of series number i
getCurrentSeriesX(j) return the j'th element of current series
getCurrentEntryX() return the current element of current series (ie the last one)
.

Members are also named as follows :

getXXX is a const member
selectXXX is non const and may create/update stuff
refXXX returns a reference
setXXX sets something

Constructor & Destructor Documentation

◆ PlotData() [1/2]

PlotData ( )

Inits a plot with series of data.

Parameters

nb_pts	number of points in each series.
nb_srs	number of series of points. Default is 1.

◆ PlotData() [2/2]

PlotData ( const PlotData & PD )

copy constructor.

Parameters

PD	a PlotData to copy.

Member Function Documentation

◆ getSeries()

const DataSeries & getSeries ( const size_t & i ) const

Returns the ith series of measurements.

Parameters

i	ith series to be returned

◆ selectSeries() [1/2]

const DataSeries & selectSeries ( const size_t & i )

Returns the ith series of measurements.

Parameters

i	ith series to be returned

◆ selectSeries() [2/2]

const DataSeries & selectSeries ( const std::string & name )

Returns the series of measurements after its name.

Parameters

nom	name of series to be returned

◆ refSeries() [1/2]

DataSeries & refSeries ( const size_t & i )

Returns the ith series of measurements.

Parameters

i	ith series to be returned

◆ refSeries() [2/2]

DataSeries & refSeries ( const std::string & nom )

Returns the ith series of measurements.

Parameters

i	ith series to be returned

◆ merge()

void merge ( const PlotData & PD )

merges another plot data to the current one.

(just adds to the end, does not merge series by name yet)

◆ size()

size_t size ( ) const

get the number of series.

Returns: number of series.

◆ setSeriesName()

void setSeriesName	(	const size_t &	i,
		const std::string &	nom )

Sets the name of a series.

Parameters

i	index of the series
nom	name of the series

◆ getSeriesName()

const std::string & getSeriesName ( const size_t & i ) const

Gets the name of a series.

Parameters

i	index of the series

◆ setCurrentSeriesName()

void setCurrentSeriesName ( const std::string & nom )

Sets the name of the current series.

Parameters

nom	name of the series

◆ initWatch()

void initWatch ( const size_t & i )

Inits the watch on a series.

Parameters

i	index of a series

◆ newSeries()

void newSeries ( const std::string & nom = "" )

Creates a new series.

It is created after the last series. getCurrentSeries() points to it.

Parameters

nom	name of the new series

◆ finishSeries()

void finishSeries ( )

Finish a series of measurements.

Nothing is done for the moment.

◆ getSeriesSize()

size_t getSeriesSize ( const size_t & i ) const

size of a series.

Parameters

i	index of the series

◆ setSeriesPointLabel()

template<class T>

void setSeriesPointLabel	(	const size_t &	i,
		const size_t &	j,
		const T &	nom )

inline

Sets the name of a point.

Parameters

i	series number
j	index for the the point
nom	name of the point

◆ setCurrentSeriesPointLabel()

void setCurrentSeriesPointLabel	(	const size_t &	j,
		const std::string &	nom )

Sets the name of a point.

Parameters

j	index for the the point
nom	name of the point

◆ getSeriesLabel()

std::string getSeriesLabel ( const size_t & i ) const

gets the name of a series.

Defaults to "series.i"

Parameters

i	its index.

Returns: its name.

◆ getCurrentSeriesLabel()

std::string getCurrentSeriesLabel ( ) const

gets the name of a series.

Defaults to "series.i"

Parameters

i	its index.

Returns: its name.

◆ getSeriesLabels()

const svector_t & getSeriesLabels ( ) const

gets all the names in the series.

Returns: a vector of names.

◆ setSeriesEntry() [1/2]

void setSeriesEntry	(	const size_t &	i,
		const std::string &	nam,
		const double &	val,
		const double &	xval = NAN,
		const double &	yval = NAN )

sets a new entry.

Parameters

i	index of the series
j	index of the point
nam	name of the point (eg size of the matrix, name of a sparse matrix,...)
val	value to be inserted (eg mflops, sec,...).
xval	x value of the point (eg size of the matrix, of a sparse matrix,...)
yval	time for this computation (seconds)

◆ setSeriesEntry() [2/2]

void setSeriesEntry	(	const std::string &	nom,
		const std::string &	nam,
		const double &	val,
		const double &	xval = NAN,
		const double &	yval = NAN )

sets a new entry.

Parameters

name	name of the series
j	index of the point
nam	name of the point (eg size of the matrix, name of a sparse matrix,...)
val	value to be inserted (eg mflops, sec,...).
xval	x value of the point (eg size of the matrix, of a sparse matrix,...)
yval	time for this computation (seconds)

◆ setCurrentSeriesEntry()

template<class T>

void setCurrentSeriesEntry	(	const T &	nam,
		const double &	val,
		const double &	xval = NAN,
		const double &	yval = NAN )

inline

sets a new entry.

Parameters

j	index of the point
nam	name of the point (eg size of the matrix, name of a sparse matrix,...)
val	value to be inserted (eg mflops, sec,...).

◆ getTable()

const std::vector< DataSeries > & getTable ( ) const

gets a reference to the array of data.

Returns: a reference to the member _tableau_ representing the data.

◆ refTable()

std::vector< DataSeries > & refTable ( )

gets a reference to the array of data.

Returns: a reference to the member _tableau_ representing the data.

◆ keepon()

bool keepon	(	size_t &	repet,
		double	tim,
		bool	usePrediction = false )

Continue for another time measure ?

See also: TimeWatcher::keepon

Parameters

repet	current number of repetitions for this new measure
tim	time previously spent on the measures.

Returns: true if one more measure can be done

◆ save()

void save	(	const std::string &	filename,
		const std::string &	title = "",
		const std::string &	xtitle = "",
		const std::string &	ytitle = "" )

saves the data in XML format.

Parameters

filename	file name
title	titles of the data
xtitle	legend of the X axis
ytitle	legend of the Y axis.

◆ getCurrentSeriesId()

const std::string & getCurrentSeriesId ( const size_t & j ) const

inline

returns the unique ID of the current series j'th entry.

Parameters

j	index of the entry.

◆ getId() [1/2]

const std::string & getId	(	const size_t &	i,
		const size_t &	j )

inline

returns the unique ID of the i'th series j'th entry.

Parameters

i	index of the series.
j	index of the entry.

◆ getId() [2/2]

const std::string & getId	(	const std::string &	name,
		const size_t &	j )

inline

returns the unique ID of the i'th series j'th entry.

Parameters

i	index of the series.
j	index of the entry.

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

benchmark.h
benchmark.C
benchmark.inl

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PlotData() [1/2]

◆ PlotData() [2/2]

Member Function Documentation

◆ getSeries()

◆ selectSeries() [1/2]

◆ selectSeries() [2/2]

◆ refSeries() [1/2]

◆ refSeries() [2/2]

◆ merge()

◆ size()

◆ setSeriesName()

◆ getSeriesName()

◆ setCurrentSeriesName()

◆ initWatch()

◆ newSeries()

◆ finishSeries()

◆ getSeriesSize()

◆ setSeriesPointLabel()

◆ setCurrentSeriesPointLabel()

◆ getSeriesLabel()

◆ getCurrentSeriesLabel()

◆ getSeriesLabels()

◆ setSeriesEntry() [1/2]

◆ setSeriesEntry() [2/2]

◆ setCurrentSeriesEntry()

◆ getTable()

◆ refTable()

◆ keepon()

◆ save()

◆ getCurrentSeriesId()

◆ getId() [1/2]

◆ getId() [2/2]