help.h File Reference

A basic help system for the mini-apps. More...

Go to the source code of this file.

Data Structures
struct	help_struct
	Description of a basic help screen. More...

Macros
#define	HELP_MAIN   0
	Indexes for help pages.
#define	HELP_HYP   1
#define	HELP_CHEBYshev   2
#define	HELP_LEGENDRE   3
#define	HELP_HERMITE   4
#define	HELP_LAGUERRE   5
#define	HELP_SUM   6
#define	HELP_DIFF   7
#define	HELP_PROD   8
#define	HELP_CONCAT   9
#define	HELP_JOIN   10
#define	HELP_GRID   11
#define	HELP_EXP   12
#define	HELP_ROT   13
#define	HELP_POLAR   14
#define	HELP_ROOTS   15
#define	HELP_DER   16
#define	HELP_UNIF   17
#define	HELP_RAND   18
#define	HELP_NORM   19
#define	HELP_SPHERE   20
#define	HELP_EVAL   21
#define	HELP_EVALD   22
#define	HELP_EVALN   23
#define	HELP_NEWTON   24
#define	HELP_COMP   25
#define	HELP_RE   26
#define	HELP_IM   27
#define	HELP_CONJ   28
#define	HELP_TENSOR   29
#define	HELP_ANALYSE   30
#define	HELP_COUNT   31
	The number of help pages.
#define	APP_COUNT   (HELP_COUNT - 1)
	The number of mini-apps.

Typedefs
typedef help_struct *	help
	Practical wrapper for arrayf_struct. More...

Functions
bool	fpe_help_print (help h)
	Prints the help screen described by h. More...
help	fpe_help_get (int ind)
	Return the help system in the list with index ind. More...
void	stats_print (char *mes, long prec, deg_t deg, char *numType, bool real, char *polyFile, char *ptsFile, char *outFile, char *outError, double timePP, long count, double timeEV, ulong tpts, char *outHorner, double timeHo, ulong tptsho, ulong tit, ulong titho)
	Prints computation stats in a standard format for automatic processing. More...

Detailed Description

A basic help system for the mini-apps.

Definition in file help.h.

Typedef Documentation

help

typedef help_struct* help

Practical wrapper for arrayf_struct.

To avoid the constant use * and & the type help_t is a pointer.

Definition at line 86 of file help.h.

Function Documentation

fpe_help_get()

help fpe_help_get

(

int

ind

)

Return the help system in the list with index ind.

Parameters

ind	the index, use constants HELP_XXX

Returns

the help sytem with the given index. Returns the list, NULL if ind is an invalid request.

fpe_help_print()

bool fpe_help_print

(

help

h

)

Prints the help screen described by h.

Parameters

h	the help screen to display

Returns

Boolean value expressing wether help could indeed be provided.

stats_print()

void stats_print	(	char *	mes,
		long	prec,
		deg_t	deg,
		char *	numType,
		bool	real,
		char *	polyFile,
		char *	ptsFile,
		char *	outFile,
		char *	outError,
		double	timePP,
		long	count,
		double	timeEV,
		ulong	tpts,
		char *	outHorner,
		double	timeHo,
		ulong	tptsho,
		ulong	tit,
		ulong	titho
	)

Prints computation stats in a standard format for automatic processing.

Parameters

mes	a short description of the computing task
prec	the precision used, in bits
deg	the degree of the polynomial
numType	the number type
real	true if it is a real polynomial, false otherwise
polyFile	the polynomial file name
ptsFile	the points list file name
outFile	the results output file name
outError	the errors list file name
timePP	pre-processing time in ns
count	the number of repetitions of the computing task
timeEV	evaluation time in ns
tpts	the total number of evaluation points (taking into acount the repetitions)
outHorner	the results output file name, computed by Horner's method
timeHo	the computing time in ns, by Horner's method
tptsho	the total number of evaluation by Horner's method
tit	total number of iterates, only for the iterative Newton method
titho	total number of iterates, only for the iterative Newton method, computed by Horner's method