SolveStatistics Class Reference
#include <IpSolveStatistics.hpp>
Inheritance diagram for SolveStatistics:
Detailed Description
This class collects statistics about an optimziation run, such as iteration count, final infeasibilities etc.It is meant to provide such information to a user of Ipopt during the finalize_solution call.
Public Member Functions | |
Constructors/Destructors | |
| SolveStatistics (const SmartPtr< IpoptNLP > &ip_nlp, const SmartPtr< IpoptData > &ip_data, const SmartPtr< IpoptCalculatedQuantities > &ip_cq) | |
| Default constructor. | |
| virtual | ~SolveStatistics () |
| Default destructor. | |
Accessor methods for retrieving different kind of solver | |
statistics information | |
| Index | IterationCount () const |
| Iteration counts. | |
| Number | TotalCPUTime () const |
| Total CPU time, including function evaluations. | |
| void | NumberOfEvaluations (Index &num_obj_evals, Index &num_constr_evals, Index &num_obj_grad_evals, Index &num_constr_jac_evals, Index &num_hess_evals) const |
| Number of NLP function evaluations. | |
| void | Infeasibilities (Number &dual_inf, Number &constr_viol, Number &complementarity, Number &kkt_error) const |
| Unscaled solution infeasibilities. | |
| void | ScaledInfeasibilities (Number &scaled_dual_inf, Number &scaled_constr_viol, Number &scaled_complementarity, Number &scaled_kkt_error) const |
| Scaled solution infeasibilities. | |
| Number | FinalObjective () const |
| Final value of objective function. | |
| Number | FinalScaledObjective () const |
| Final scaled value of objective function. | |
Constructor & Destructor Documentation
| SolveStatistics | ( | const SmartPtr< IpoptNLP > & | ip_nlp, | |
| const SmartPtr< IpoptData > & | ip_data, | |||
| const SmartPtr< IpoptCalculatedQuantities > & | ip_cq | |||
| ) |
Default constructor.
It takes in those collecting Ipopt objects that can provide the statistics information. Those statistics are retrieved at the time of the constructor call.
| virtual ~SolveStatistics | ( | ) | [inline, virtual] |
Default destructor.
Member Function Documentation
| Index IterationCount | ( | ) | const |
Iteration counts.
| Number TotalCPUTime | ( | ) | const |
Total CPU time, including function evaluations.
| void NumberOfEvaluations | ( | Index & | num_obj_evals, | |
| Index & | num_constr_evals, | |||
| Index & | num_obj_grad_evals, | |||
| Index & | num_constr_jac_evals, | |||
| Index & | num_hess_evals | |||
| ) | const |
Number of NLP function evaluations.
| void Infeasibilities | ( | Number & | dual_inf, | |
| Number & | constr_viol, | |||
| Number & | complementarity, | |||
| Number & | kkt_error | |||
| ) | const |
Unscaled solution infeasibilities.
| void ScaledInfeasibilities | ( | Number & | scaled_dual_inf, | |
| Number & | scaled_constr_viol, | |||
| Number & | scaled_complementarity, | |||
| Number & | scaled_kkt_error | |||
| ) | const |
Scaled solution infeasibilities.
| Number FinalObjective | ( | ) | const |
Final value of objective function.
| Number FinalScaledObjective | ( | ) | const |
Final scaled value of objective function.
The documentation for this class was generated from the following files:
