Ipopt::SolveStatistics Class Reference

This class collects statistics about an optimziation run, such as iteration count, final infeasibilities etc. More...

#include <IpSolveStatistics.hpp>

Inheritance diagram for Ipopt::SolveStatistics:
Inheritance graph
[legend]

List of all members.

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



virtual Index IterationCount () const
 Iteration counts.
virtual Number TotalCpuTime () const
 Total CPU time, including function evaluations.
Number TotalCPUTime () const
 Total CPU time, including function evaluations.
virtual Number TotalSysTime () const
 Total System time, including function evaluations.
virtual Number TotalWallclockTime () const
 Total wall clock time, including function evaluations.
virtual 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.
virtual void Infeasibilities (Number &dual_inf, Number &constr_viol, Number &complementarity, Number &kkt_error) const
 Unscaled solution infeasibilities.
virtual void ScaledInfeasibilities (Number &scaled_dual_inf, Number &scaled_constr_viol, Number &scaled_complementarity, Number &scaled_kkt_error) const
 Scaled solution infeasibilities.
virtual Number FinalObjective () const
 Final value of objective function.
virtual Number FinalScaledObjective () const
 Final scaled value of objective function.

Private Member Functions

Default Compiler Generated Methods

(Hidden to avoid implicit creation/calling).

These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.



 SolveStatistics ()
 Default Constructor.
 SolveStatistics (const SolveStatistics &)
 Copy Constructor.
void operator= (const SolveStatistics &)
 Overloaded Equals Operator.

Private Attributes

Fields for storing the statistics data



Index num_iters_
 Number of iterations.
Number total_cpu_time_
Number total_sys_time_
Number total_wallclock_time_
Index num_obj_evals_
 Number of objective function evaluations.
Index num_constr_evals_
 Number of constraints evaluations (max of equality and inequality).
Index num_obj_grad_evals_
 Number of objective gradient evaluations.
Index num_constr_jac_evals_
 Number of constraint Jacobian evaluations.
Index num_hess_evals_
 Number of Lagrangian Hessian evaluations.
Number scaled_obj_val_
 Final scaled value of objective function.
Number obj_val_
 Final unscaled value of objective function.
Number scaled_dual_inf_
 Final scaled dual infeasibility (max-norm).
Number dual_inf_
 Final unscaled dual infeasibility (max-norm).
Number scaled_constr_viol_
 Final scaled constraint violation (max-norm).
Number constr_viol_
 Final unscaled constraint violation (max-norm).
Number scaled_compl_
 Final scaled complementarity error (max-norm).
Number compl_
 Final unscaled complementarity error (max-norm).
Number scaled_kkt_error_
 Final overall scaled KKT error (max-norm).
Number kkt_error_
 Final overall unscaled KKT error (max-norm).

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.

Definition at line 27 of file IpSolveStatistics.hpp.


Constructor & Destructor Documentation

Ipopt::SolveStatistics::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 Ipopt::SolveStatistics::~SolveStatistics (  )  [inline, virtual]

Default destructor.

Definition at line 41 of file IpSolveStatistics.hpp.

Ipopt::SolveStatistics::SolveStatistics (  )  [private]

Default Constructor.

Ipopt::SolveStatistics::SolveStatistics ( const SolveStatistics  )  [private]

Copy Constructor.


Member Function Documentation

virtual Index Ipopt::SolveStatistics::IterationCount (  )  const [virtual]

Iteration counts.

virtual Number Ipopt::SolveStatistics::TotalCpuTime (  )  const [virtual]

Total CPU time, including function evaluations.

Number Ipopt::SolveStatistics::TotalCPUTime (  )  const [inline]

Total CPU time, including function evaluations.

Included for backward compatibility.

Definition at line 54 of file IpSolveStatistics.hpp.

virtual Number Ipopt::SolveStatistics::TotalSysTime (  )  const [virtual]

Total System time, including function evaluations.

virtual Number Ipopt::SolveStatistics::TotalWallclockTime (  )  const [virtual]

Total wall clock time, including function evaluations.

virtual void Ipopt::SolveStatistics::NumberOfEvaluations ( Index num_obj_evals,
Index num_constr_evals,
Index num_obj_grad_evals,
Index num_constr_jac_evals,
Index num_hess_evals 
) const [virtual]

Number of NLP function evaluations.

virtual void Ipopt::SolveStatistics::Infeasibilities ( Number dual_inf,
Number constr_viol,
Number complementarity,
Number kkt_error 
) const [virtual]

Unscaled solution infeasibilities.

virtual void Ipopt::SolveStatistics::ScaledInfeasibilities ( Number scaled_dual_inf,
Number scaled_constr_viol,
Number scaled_complementarity,
Number scaled_kkt_error 
) const [virtual]

Scaled solution infeasibilities.

virtual Number Ipopt::SolveStatistics::FinalObjective (  )  const [virtual]

Final value of objective function.

virtual Number Ipopt::SolveStatistics::FinalScaledObjective (  )  const [virtual]

Final scaled value of objective function.

void Ipopt::SolveStatistics::operator= ( const SolveStatistics  )  [private]

Overloaded Equals Operator.


Member Data Documentation

Number of iterations.

Definition at line 106 of file IpSolveStatistics.hpp.

Definition at line 108 of file IpSolveStatistics.hpp.

Definition at line 110 of file IpSolveStatistics.hpp.

Definition at line 112 of file IpSolveStatistics.hpp.

Number of objective function evaluations.

Definition at line 114 of file IpSolveStatistics.hpp.

Number of constraints evaluations (max of equality and inequality).

Definition at line 117 of file IpSolveStatistics.hpp.

Number of objective gradient evaluations.

Definition at line 119 of file IpSolveStatistics.hpp.

Number of constraint Jacobian evaluations.

Definition at line 121 of file IpSolveStatistics.hpp.

Number of Lagrangian Hessian evaluations.

Definition at line 123 of file IpSolveStatistics.hpp.

Final scaled value of objective function.

Definition at line 126 of file IpSolveStatistics.hpp.

Final unscaled value of objective function.

Definition at line 128 of file IpSolveStatistics.hpp.

Final scaled dual infeasibility (max-norm).

Definition at line 130 of file IpSolveStatistics.hpp.

Final unscaled dual infeasibility (max-norm).

Definition at line 132 of file IpSolveStatistics.hpp.

Final scaled constraint violation (max-norm).

Definition at line 134 of file IpSolveStatistics.hpp.

Final unscaled constraint violation (max-norm).

Definition at line 136 of file IpSolveStatistics.hpp.

Final scaled complementarity error (max-norm).

Definition at line 138 of file IpSolveStatistics.hpp.

Final unscaled complementarity error (max-norm).

Definition at line 140 of file IpSolveStatistics.hpp.

Final overall scaled KKT error (max-norm).

Definition at line 142 of file IpSolveStatistics.hpp.

Final overall unscaled KKT error (max-norm).

Definition at line 144 of file IpSolveStatistics.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 20 Sep 2016 for Ipopt by  doxygen 1.6.1