commentator.h File Reference

Reports information to the user. More...

#include <deque>
#include <stack>
#include <map>
#include <list>
#include <string>
#include <iostream>
#include <streambuf>
#include <fstream>
#include <cstring>
#include "givaro/givtimer.h"
#include "linbox/util/commentator.inl"
#include "linbox/util/args-parser.h"

Data Structures
class	ActivityState
	used by commentator More...
class	Commentator
	Give information to user during runtime. More...
struct	Commentator::StepsAndTime
struct	Commentator::Activity
struct	Commentator::C_str_Less
class	MessageClass

Namespaces
namespace	LinBox
	Namespace in which all linbox code resides.

Macros
#define	MAX(a, b)
#define	BRIEF_REPORT   "Brief report"
#define	PROGRESS_REPORT   "Progress report"
#define	TIMING_MEASURE   "Timing measure"
#define	TIMING_ESTIMATE   "Timing estimate"
#define	PARTIAL_RESULT   "Partial result"
#define	INTERNAL_WARNING   "Internal warning"
#define	INTERNAL_ERROR   "Internal error"
#define	INTERNAL_DESCRIPTION   "Internal description"
#define	MSG_OK   "ok"
#define	MSG_DONE   "done"
#define	MSG_PASSED   "passed"
#define	MSG_FAILED   "FAILED"
#define	MSG_STATUS(ret)
#define	aside   commentator().report(Commentator::LEVEL_IMPORTANT, INTERNAL_DESCRIPTON)

Functions
Commentator &	commentator ()
Commentator &	commentator (std::ostream &stream)
void	parseArguments (int argc, char **argv, Argument *args, bool printDefaults=true)

Detailed Description

Reports information to the user.

Macro Definition Documentation

MAX

#define MAX	(		a,
			b )

Value:

(((a) > (b)) ? (a) : (b))

BRIEF_REPORT

#define BRIEF_REPORT   "Brief report"

PROGRESS_REPORT

#define PROGRESS_REPORT   "Progress report"

TIMING_MEASURE

#define TIMING_MEASURE   "Timing measure"

TIMING_ESTIMATE

#define TIMING_ESTIMATE   "Timing estimate"

PARTIAL_RESULT

#define PARTIAL_RESULT   "Partial result"

INTERNAL_WARNING

#define INTERNAL_WARNING   "Internal warning"

INTERNAL_ERROR

#define INTERNAL_ERROR   "Internal error"

INTERNAL_DESCRIPTION

#define INTERNAL_DESCRIPTION   "Internal description"

MSG_OK

#define MSG_OK   "ok"

MSG_DONE

#define MSG_DONE   "done"

MSG_PASSED

#define MSG_PASSED   "passed"

MSG_FAILED

#define MSG_FAILED   "FAILED"

MSG_STATUS

#define MSG_STATUS

(

ret

)

Value:

(ret ? MSG_PASSED : MSG_FAILED)

aside

#define aside   commentator().report(Commentator::LEVEL_IMPORTANT, INTERNAL_DESCRIPTON)