APPSPACK::Print Class Reference

#include <APPSPACK_Print.hpp>

Detailed Description

Printing utilities.

Parameters

The following parameters in the "Solver" sublist (i.e., the sublist that is passed to this object's constructor) affect how this class behaves. See Solver Parameters for full details on these parameters.

"Debug" - specifies how much information to bring out
"Precision" - specifies the precision for the doubles that are printed out

Definition at line 69 of file APPSPACK_Print.hpp.

Public Types

enum PrintType {
FinalSolution = 1, NewBestPoint = 2, InitialData = 3, EvaluatedPoints = 4,
NewBestDirections = 5, UnevaluatedPoints = 6, Directions = 7
}

Enumerated type that specifies what debugging information to print; see debug and doPrint(). More...

Public Member Functions

Print (Parameter::List &params)

Constructor. Sets precision and debug from parameter list.

~Print ()

Destructor. (Does nothing.).

Static Public Member Functions

PrintablePositiveDouble formatPositiveDouble (double d, int precision_in=-1)

Prints a positive double using the specified precision.

PrintableDouble formatDouble (double d, int precision_in=-1)

Prints a double using the specified precision.

bool doPrint (enum PrintType type)

Return true if the type of item specified should be printed given the current value of debug.

Static Public Attributes

unsigned int debug

Debug level.

int precision

Precision for output of real numbers.

Member Enumeration Documentation

enum APPSPACK::Print::PrintType

Enumerated type that specifies what debugging information to print; see debug and doPrint().
If debug = n, then everything with a value <= n is printed. So, for example, if debug = 3, then the final solution, all new minima, and the initial data is printed.
Enumeration values:

FinalSolution Final Solution.

NewBestPoint Every new minimum.

InitialData Initial data.

EvaluatedPoints All evaluated trial points.

NewBestDirections Directions corresponding to new minimum.

UnevaluatedPoints All unevaluated trial points.

Directions Directions at every iteration.

Definition at line 84 of file APPSPACK_Print.hpp.

Constructor & Destructor Documentation

APPSPACK::Print::Print ( Parameter::List & params )

Constructor. Sets precision and debug from parameter list.

Definition at line 45 of file APPSPACK_Print.cpp.
References debug, APPSPACK::Parameter::List::getParameter(), and precision.

APPSPACK::Print::~Print ( )

Destructor. (Does nothing.).

Definition at line 52 of file APPSPACK_Print.cpp.

Member Function Documentation

APPSPACK::Print::PrintablePositiveDouble APPSPACK::Print::formatPositiveDouble ( double d,

int precision_in = -1

) [static]

Prints a positive double using the specified precision.

Definition at line 57 of file APPSPACK_Print.cpp.
Referenced by APPSPACK::Point::leftshift().

APPSPACK::Print::PrintableDouble APPSPACK::Print::formatDouble ( double d,

int precision_in = -1

) [static]

Prints a double using the specified precision.

Definition at line 62 of file APPSPACK_Print.cpp.
Referenced by APPSPACK::Vector::leftshift(), and APPSPACK::Matrix::leftshift().

bool APPSPACK::Print::doPrint ( enum PrintType type ) [static]

Return true if the type of item specified should be printed given the current value of debug.

Definition at line 67 of file APPSPACK_Print.cpp.
References debug.

Member Data Documentation

unsigned int APPSPACK::Print::debug [static]

Debug level.
This controls how much information is printed to the screen. The higher the value, the more information that's printed. See "Debug" in Solver Parameters.
Definition at line 43 of file APPSPACK_Print.cpp.
Referenced by doPrint(), and Print().

int APPSPACK::Print::precision [static]

Precision for output of real numbers.
See "Precision" in Solver Parameters.
Definition at line 42 of file APPSPACK_Print.cpp.
Referenced by Print().

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


Public Types
enum	PrintType { FinalSolution = 1, NewBestPoint = 2, InitialData = 3, EvaluatedPoints = 4, NewBestDirections = 5, UnevaluatedPoints = 6, Directions = 7 }
	Enumerated type that specifies what debugging information to print; see debug and doPrint(). More...
Public Member Functions
	Print (Parameter::List &params)
	Constructor. Sets precision and debug from parameter list.
	~Print ()
	Destructor. (Does nothing.).
Static Public Member Functions
PrintablePositiveDouble	formatPositiveDouble (double d, int precision_in=-1)
	Prints a positive double using the specified precision.
PrintableDouble	formatDouble (double d, int precision_in=-1)
	Prints a double using the specified precision.
bool	doPrint (enum PrintType type)
	Return true if the type of item specified should be printed given the current value of debug.
Static Public Attributes
unsigned int	debug
	Debug level.
int	precision
	Precision for output of real numbers.