averages.c File Reference

Detailed Description

Implementation of the auxiliary functions to compute averages of sets of experiments.

See Also

averages.h

Definition in file averages.c.

Functions
void	InitAverages (unsigned int m, boolean useCharts, boolean useSamples, unsigned int maxIt, Taverages *av)
	Initializes a set of averages. More...
void	NewSuccesfulExperiment (double t, unsigned int mem, double pl, double pc, unsigned int nc, unsigned int ns, double *time, double *cost, Taverages *av)
	Adds data of a new experiment. More...
void	PrintAveragesHeader (FILE *f, int argc, char **arg, Taverages *av)
	Prints a header to the averages results. More...
void	PrintAverages (FILE *f, Taverages *av)
	Prints the averages of a set of experiments. More...
void	DeleteAverages (Taverages *av)
	Deletes the space used by a set of averages. More...

Function Documentation

void InitAverages	(	unsigned int	m,
		boolean	useCharts,
		boolean	useSamples,
		unsigned int	maxIt,
		Taverages *	av
	)

Initializes a set of averages. This is used by different planners and, thus, it is parametrizable since each planner uses its own elements (samples, charts or both).

Parameters

m	Max number of experiments.
useCharts	TRUE if the experiment involves charts.
useSamples	TRUE if the experiment involves samples.
maxIt	If different from NO_UINT, we store statistics of the cost and time per iteration. This is only used in RRTStar algorithms.
av	The average set.

Definition at line 21 of file averages.c.

References Taverages::cost, Taverages::costStd, Taverages::maxExperiments, Taverages::maxIt, Taverages::memory, Taverages::nCharts, Taverages::ncost, NEW, NO_UINT, Taverages::nSamples, Taverages::nSuccess, Taverages::pathCost, Taverages::pathLength, Taverages::time, Taverages::times, and Taverages::timeStd.

Referenced by main().

void NewSuccesfulExperiment	(	double	t,
		unsigned int	mem,
		double	pl,
		double	pc,
		unsigned int	nc,
		unsigned int	ns,
		double *	time,
		double *	cost,
		Taverages *	av
	)

Parameters

t	Time used (in seconds).
mem	The memory used (in bytes).
pl	Path lenght.
pc	Path cost.
nc	Number of charts (sometimes not used, see InitAverages).
ns	Number of samples (sometimes not used, see InitAverages).
time	Execution time per iteration. Only used if different form NULL and if maxIt is different form NO_UINT in InitAverages.
cost	Cost to goal per iteration. Only used if different form NULL and if maxIt is different form NO_UINT in InitAverages.
av	The average set to update.

Definition at line 75 of file averages.c.

References Taverages::cost, Taverages::costStd, Error(), Taverages::maxExperiments, Taverages::maxIt, Taverages::memory, Taverages::nCharts, Taverages::ncost, NO_UINT, Taverages::nSamples, Taverages::nSuccess, Taverages::pathCost, Taverages::pathLength, Taverages::time, Taverages::times, and Taverages::timeStd.

Referenced by main().

void PrintAveragesHeader	(	FILE *	f,
		int	argc,
		char **	arg,
		Taverages *	av
	)

Prints the header of the averages of a set of experiments.

This is separated from PrintAverages because in some cases we insert some information between the header and the averages themselves.

Parameters

f	The file where to print the header.
argc	Number of parameters used when calling the program.
arg	The parameters.
av	The averages to print.

Definition at line 149 of file averages.c.

Referenced by main().

void PrintAverages	(	FILE *	f,
		Taverages *	av
	)

Prints the averages of a set of experiments. If 'p' and 'pn' are different from NULL, the header is automatically added before the statistics info.

Parameters

f	The file where to print the averages.
av	The averages to print.

Definition at line 170 of file averages.c.

References Taverages::cost, Taverages::costStd, ITERATIONS_BETWEEN_DATA, Taverages::maxExperiments, Taverages::maxIt, Mean(), Taverages::memory, Taverages::nCharts, Taverages::ncost, NO_UINT, Taverages::nSamples, Taverages::nSuccess, Taverages::pathCost, Taverages::pathLength, StdDev(), Taverages::time, Taverages::times, and Taverages::timeStd.

Referenced by main().

void DeleteAverages

(

Taverages *

av

)

Release the memory used by a set of averages.

Parameters

av	The set of averages.

Definition at line 263 of file averages.c.

References Taverages::cost, Taverages::costStd, Taverages::maxIt, Taverages::memory, Taverages::nCharts, Taverages::ncost, NO_UINT, Taverages::nSamples, Taverages::pathCost, Taverages::pathLength, Taverages::time, Taverages::times, and Taverages::timeStd.

Referenced by main().