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:

Public Member Functions
Constructors/Destructors
	SolveStatistics (const SmartPtr< IpoptNLP > &ip_nlp, const SmartPtr< IpoptData > &ip_data, const SmartPtr< IpoptCalculatedQuantities > &ip_cq)
	Default constructor. More...
virtual	~SolveStatistics ()
	Default destructor. More...
Accessor methods for retrieving different kind of solver
statistics information
virtual Index	IterationCount () const
	Iteration counts. More...
virtual Number	TotalCpuTime () const
	Total CPU time, including function evaluations. More...
Number	TotalCPUTime () const
	Total CPU time, including function evaluations. More...
virtual Number	TotalSysTime () const
	Total System time, including function evaluations. More...
virtual Number	TotalWallclockTime () const
	Total wall clock time, including function evaluations. More...
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. More...
virtual void	Infeasibilities (Number &dual_inf, Number &constr_viol, Number &complementarity, Number &kkt_error) const
	Unscaled solution infeasibilities. More...
virtual void	ScaledInfeasibilities (Number &scaled_dual_inf, Number &scaled_constr_viol, Number &scaled_complementarity, Number &scaled_kkt_error) const
	Scaled solution infeasibilities. More...
virtual Number	FinalObjective () const
	Final value of objective function. More...
virtual Number	FinalScaledObjective () const
	Final scaled value of objective function. More...
Public Member Functions inherited from Ipopt::ReferencedObject
	ReferencedObject ()
virtual	~ReferencedObject ()
Index	ReferenceCount () const
void	AddRef (const Referencer *referencer) const
void	ReleaseRef (const Referencer *referencer) const

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. More...
	SolveStatistics (const SolveStatistics &)
	Copy Constructor. More...
void	operator= (const SolveStatistics &)
	Overloaded Equals Operator. More...

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

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 ( )

inlinevirtual

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

Index Ipopt::SolveStatistics::num_iters_

private

Number of iterations.

Definition at line 106 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::total_cpu_time_

private

Definition at line 108 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::total_sys_time_

private

Definition at line 110 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::total_wallclock_time_

private

Definition at line 112 of file IpSolveStatistics.hpp.

Index Ipopt::SolveStatistics::num_obj_evals_

private

Number of objective function evaluations.

Definition at line 114 of file IpSolveStatistics.hpp.

Index Ipopt::SolveStatistics::num_constr_evals_

private

Number of constraints evaluations (max of equality and inequality)

Definition at line 117 of file IpSolveStatistics.hpp.

Index Ipopt::SolveStatistics::num_obj_grad_evals_

private

Number of objective gradient evaluations.

Definition at line 119 of file IpSolveStatistics.hpp.

Index Ipopt::SolveStatistics::num_constr_jac_evals_

private

Number of constraint Jacobian evaluations.

Definition at line 121 of file IpSolveStatistics.hpp.

Index Ipopt::SolveStatistics::num_hess_evals_

private

Number of Lagrangian Hessian evaluations.

Definition at line 123 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::scaled_obj_val_

private

Final scaled value of objective function.

Definition at line 126 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::obj_val_

private

Final unscaled value of objective function.

Definition at line 128 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::scaled_dual_inf_

private

Final scaled dual infeasibility (max-norm)

Definition at line 130 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::dual_inf_

private

Final unscaled dual infeasibility (max-norm)

Definition at line 132 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::scaled_constr_viol_

private

Final scaled constraint violation (max-norm)

Definition at line 134 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::constr_viol_

private

Final unscaled constraint violation (max-norm)

Definition at line 136 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::scaled_compl_

private

Final scaled complementarity error (max-norm)

Definition at line 138 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::compl_

private

Final unscaled complementarity error (max-norm)

Definition at line 140 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::scaled_kkt_error_

private

Final overall scaled KKT error (max-norm)

Definition at line 142 of file IpSolveStatistics.hpp.

Number Ipopt::SolveStatistics::kkt_error_

private

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:

• src/Interfaces/IpSolveStatistics.hpp