Represents the solution of an optimization problem when errors occurred during the solving process. More...
#include <roboptim/core/result-with-warnings.hh>
Public Member Functions | |
| ResultWithWarnings (const Function::size_type inputSize, const Function::size_type outputSize=1) | |
| Instantiate the class from an input/output size. | |
| ~ResultWithWarnings () | |
| virtual std::ostream & | print (std::ostream &o) const |
| Display the result on the specified output stream. | |
| 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. | |
| virtual | ~Result () |
Public Attributes | |
| std::vector< SolverWarning > | warnings |
| Vector of warnings. | |
| Public Attributes inherited from roboptim::Result | |
| size_type | inputSize |
| Input size (i.e. argument size). | |
| size_type | outputSize |
| Output size (i.e. result size). | |
| vector_t | x |
| Point found by the solver. | |
| vector_t | value |
| Function value at the solver found point. | |
| vector_t | constraints |
| Constraints final values. | |
| vector_t | lambda |
| Lagrange multipliers. | |
Additional Inherited Members | |
| Public Types inherited from roboptim::Result | |
| typedef Function::size_type | size_type |
| Import size type from Function class. | |
| typedef Function::vector_t | vector_t |
| Import vector type from Function class. | |
Detailed Description
Represents the solution of an optimization problem when errors occurred during the solving process.
This class is returned by a solver if a result has been found, but some problems happened.
A vector or warnings is provided in this result, otherwise the class behaves like Result.
Constructor & Destructor Documentation
◆ ResultWithWarnings()
|
explicit |
Instantiate the class from an input/output size.
- Parameters
-
inputSize input size outputSize output size
References roboptim::Result::Result(), and warnings.
◆ ~ResultWithWarnings()
| roboptim::ResultWithWarnings::~ResultWithWarnings | ( | ) |
Member Function Documentation
◆ print()
|
virtual |
Display the result on the specified output stream.
- Parameters
-
o output stream used for display
- Returns
- output stream
Reimplemented from roboptim::Result.
References roboptim::decindent(), roboptim::iendl(), roboptim::incindent(), roboptim::Result::print(), and warnings.
Member Data Documentation
◆ warnings
| std::vector<SolverWarning> roboptim::ResultWithWarnings::warnings |
Vector of warnings.
Each element of this vector is a potential problem that occurred during the optimization.
Referenced by print(), and ResultWithWarnings().