roboptim::SolverWarning Class Reference

Exception used for non-critical errors during optimization. More...

#include <roboptim/core/solver-warning.hh>

Inheritance diagram for roboptim::SolverWarning:

Collaboration diagram for roboptim::SolverWarning:

Public Member Functions
	SolverWarning (const std::string &arg)
	Instantiate the class with a message.
virtual std::ostream &	print (std::ostream &) const
	Display the problem on the specified output stream.
Public Member Functions inherited from roboptim::SolverError
	SolverError (const std::string &arg)
	Instantiate an error from an error message.
	SolverError (const std::string &arg, const Result &res)
	Instantiate an error from an error message.
	SolverError (const SolverError &error)
	Copy constructor.
	~SolverError ()
	Trivial destructor.
const boost::optional< Result > &	lastState () const
	Retrieve the (optional) last state of the solver.
boost::optional< Result > &	lastState ()
	Retrieve the (optional) last state of the solver.

Detailed Description

Exception used for non-critical errors during optimization.

This class is mainly used to populate the warning vector of the ResultWithWarnings class.

Constructor & Destructor Documentation

SolverWarning()

roboptim::SolverWarning::SolverWarning ( const std::string & arg )

explicit

Instantiate the class with a message.

Parameters

arg

message

References roboptim::SolverError::SolverError().

Member Function Documentation

print()

std::ostream & roboptim::SolverWarning::print ( std::ostream & o ) const

virtual

Display the problem on the specified output stream.

Parameters

o	output stream used for display

Returns

output stream

Reimplemented from roboptim::SolverError.