All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
roboptim::ResultWithWarnings Class Reference

Warnings have been merged to Result to simplify the API. More...

#include <roboptim/core/result-with-warnings.hh>

Inheritance diagram for roboptim::ResultWithWarnings:
roboptim::Result

Public Types

typedef Result::size_type size_type
 Import size type from Result class. More...
 
- Public Types inherited from roboptim::Result
typedef Function::size_type size_type
 Import size type from Function class. More...
 
typedef Function::value_type value_type
 Import value type from Function class. More...
 
typedef Function::vector_t vector_t
 Import vector type from Function class. More...
 
typedef Function::argument_t argument_t
 Import argument type from Function class. More...
 
typedef Function::result_t result_t
 Import result type from Function class. More...
 

Public Member Functions

 ResultWithWarnings (const size_type inputSize, const size_type outputSize=1)
 
 ~ResultWithWarnings ()
 
- Public Member Functions inherited from roboptim::Result
 Result (const size_type inputSize, const size_type outputSize=1)
 Instantiate a result and fix input/output sizes. More...
 
virtual ~Result ()
 
virtual std::ostream & print (std::ostream &o) const
 Display the result on the specified output stream. More...
 

Additional Inherited Members

- Public Attributes inherited from roboptim::Result
size_type inputSize
 Input size (i.e. argument size). More...
 
size_type outputSize
 Output size (i.e. result size). More...
 
argument_t x
 Point found by the solver. More...
 
result_t value
 Function value at the point found by the solver. More...
 
result_t constraints
 Final constraints values. More...
 
value_type constraint_violation
 Final violation of the constraints. More...
 
vector_t lambda
 Lagrange multipliers. More...
 
std::vector< SolverWarningwarnings
 Vector of warnings. More...
 

Detailed Description

Warnings have been merged to Result to simplify the API.

To prevent issues with existing visitors, we cannot use a simple typedef such as:

Deprecated:
Deprecated since version 3.3. Use Result instead.

Member Typedef Documentation

Constructor & Destructor Documentation

roboptim::ResultWithWarnings::ResultWithWarnings ( const size_type  inputSize,
const size_type  outputSize = 1 
)
explicit
roboptim::ResultWithWarnings::~ResultWithWarnings ( )