Scippy

SoPlex

Sequential object-oriented simPlex

Wrapper for several output streams. A verbosity level is used to decide which stream to use and whether to really print a given message. Regardless of whether the verbosity level is set via a manipulator or via the member function, it is persistent until a new value is set. More...

#include <spxout.h>

Classes
struct	struct_Verbosity
	helper struct for the output operator More...

Public Types
Output control types
enum	Verbosity { ERROR = 0, WARNING = 1, DEBUG = 2, INFO1 = 3, INFO2 = 4, INFO3 = 5 }
	Verbosity level. More...

Public Member Functions
Construction / destruction
	SPxOut ()
	constructor More...

virtual	~SPxOut ()
	destructor More...

	SPxOut (const SPxOut &)
	copy constructor More...

SPxOut &	operator= (const SPxOut &)
	assignment operator More...

Verbosity
virtual void	setVerbosity (const Verbosity &v)

Verbosity	getVerbosity () const

Wrappers for the current stream
bool	good () const

bool	operator! () const

std::streamsize	precision () const

Private Attributes
Private data
Verbosity	m_verbosity
	verbosity level More...

std::ostream **	m_streams
	array of pointers to internal streams, indexed by verbosity level More...

Getting / setting streams
virtual void	setStream (const Verbosity &verbosity, std::ostream &stream)
	Sets the stream for the specified verbosity level. More...

std::ostream &	getStream (const Verbosity &verbosity) const
	Returns the stream for the specified verbosity level. More...

std::ostream &	getCurrentStream () const
	Returns the stream for the current verbosity. More...

static void	setScientific (std::ostream &stream, int precision=8)
	Sets the precision of the stream to 16 and the floatfield to scientifix. More...

static void	setFixed (std::ostream &stream, int precision=8)
	Sets the precision of the stream to 8 and the floatfield to fixed. More...

Detailed Description

Wrapper for several output streams. A verbosity level is used to decide which stream to use and whether to really print a given message. Regardless of whether the verbosity level is set via a manipulator or via the member function, it is persistent until a new value is set.

Most ostream member functions are not provided here; use the corresponding stream manipulators (e.g., setprecision()) instead. These are passed on to the current ostream, which is chosen according to the verbosity level. In particular, this means that the first element in an output stream should always be the verbosity. For instance, use

spxout << verb( SPxOut::WARNING ) << std::setw( 15 ) << 42 << std::endl;

or

spxout.setVerbosity( SPxOut::WARNING );

spxout << std::setw( 15 ) << 42 << std::endl;

instead of

spxout << std::setw( 15 ) << verb( SPxOut::WARNING ) << 42 << std::endl;

in order to make sure that std::setw( 15 ) is applied to the warning stream.

Definition at line 63 of file spxout.h.

Member Enumeration Documentation

◆ Verbosity

Verbosity level.

Enumerator
ERROR
WARNING
DEBUG
INFO1
INFO2
INFO3

Definition at line 72 of file spxout.h.

Constructor & Destructor Documentation

◆ SPxOut() [1/2]

SPxOut ( )

constructor

Definition at line 23 of file spxout.cpp.

References SPxOut::DEBUG, SPxOut::ERROR, SPxOut::INFO3, SPxOut::m_streams, soplex::spx_alloc(), and SPxOut::WARNING.

◆ ~SPxOut()

~SPxOut ( )

virtual

destructor

Definition at line 37 of file spxout.cpp.

References SPxOut::m_streams, and soplex::spx_free().

◆ SPxOut() [2/2]

SPxOut ( const SPxOut & rhs )

copy constructor

Definition at line 52 of file spxout.cpp.

References SPxOut::DEBUG, SPxOut::ERROR, SPxOut::INFO3, SPxOut::m_streams, SPxOut::m_verbosity, soplex::spx_alloc(), and SPxOut::WARNING.

Member Function Documentation

◆ getCurrentStream()

std::ostream& getCurrentStream ( ) const

Returns the stream for the current verbosity.

Definition at line 164 of file spxout.h.

References SPxOut::getStream(), and SPxOut::getVerbosity().

Referenced by SPxOut::good(), SPxOut::operator!(), SPxOut::precision(), and SoPlex::printUserSettings().

◆ getStream()

std::ostream& getStream ( const Verbosity & verbosity ) const

Returns the stream for the specified verbosity level.

Definition at line 157 of file spxout.h.

References SPxOut::m_streams.

Referenced by SPxOut::getCurrentStream(), main(), SoPlex::optimize(), and Validation::validateSolveReal().

◆ getVerbosity()

Verbosity getVerbosity ( ) const

Definition at line 117 of file spxout.h.

References SPxOut::m_verbosity.

Referenced by SoPlex::_solveDecompositionDualSimplex(), SPxOut::getCurrentStream(), and SoPlex::printDecompDisplayLine().

◆ good()

bool good ( ) const

Definition at line 129 of file spxout.h.

References SPxOut::getCurrentStream().

◆ operator!()

bool operator! ( ) const

Definition at line 134 of file spxout.h.

References SPxOut::getCurrentStream().

◆ operator=()

SPxOut & operator= ( const SPxOut & base )

assignment operator

Definition at line 42 of file spxout.cpp.

References SPxOut::DEBUG, SPxOut::INFO3, SPxOut::m_streams, and SPxOut::m_verbosity.

◆ precision()

std::streamsize precision ( ) const

Definition at line 139 of file spxout.h.

References SPxOut::getCurrentStream().

Referenced by SPxSolver::computeCoTest(), SPxSolver::computeFtest(), SPxSolver::computeTest(), main(), SPxOut::setFixed(), and SPxOut::setScientific().

◆ setFixed()

static void setFixed	(	std::ostream &	stream,
		int	precision = `8`
	)

static

Sets the precision of the stream to 8 and the floatfield to fixed.

Definition at line 177 of file spxout.h.

References SPxOut::precision().

Referenced by SoPlex::Statistics::print(), SPxLPBase< Real >::printProblemStatistics(), SoPlex::printShortStatistics(), SoPlex::printStatistics(), SoPlex::printUserSettings(), and SoPlex::saveSettingsFile().

◆ setScientific()

static void setScientific	(	std::ostream &	stream,
		int	precision = `8`
	)

static

Sets the precision of the stream to 16 and the floatfield to scientifix.

Definition at line 171 of file spxout.h.

References SPxOut::precision().

Referenced by SoPlex::Statistics::print(), SoPlex::printShortStatistics(), SoPlex::printSolutionStatistics(), SoPlex::printUserSettings(), and SoPlex::saveSettingsFile().

◆ setStream()

virtual void setStream	(	const Verbosity &	verbosity,
		std::ostream &	stream
	)

virtual

Sets the stream for the specified verbosity level.

Definition at line 150 of file spxout.h.

References SPxOut::m_streams.

Referenced by main().

◆ setVerbosity()

virtual void setVerbosity ( const Verbosity & v )

virtual

Definition at line 111 of file spxout.h.

References SPxOut::m_verbosity.

Referenced by SoPlex::_solveDecompositionDualSimplex(), main(), soplex::operator<<(), SoPlex::printDecompDisplayLine(), and SoPlex::setIntParam().

Member Data Documentation

◆ m_streams

std::ostream** m_streams

private

array of pointers to internal streams, indexed by verbosity level

Definition at line 191 of file spxout.h.

Referenced by SPxOut::getStream(), SPxOut::operator=(), SPxOut::setStream(), SPxOut::SPxOut(), and SPxOut::~SPxOut().

◆ m_verbosity

Verbosity m_verbosity

private

verbosity level

Definition at line 189 of file spxout.h.

Referenced by SPxOut::getVerbosity(), SPxOut::operator=(), SPxOut::setVerbosity(), and SPxOut::SPxOut().