Ipopt  3.12.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
Ipopt::InexactNormalTerminationTester Class Reference

This class implements the termination tests for the primal-dual system. More...

#include <IpInexactNormalTerminationTester.hpp>

+ Inheritance diagram for Ipopt::InexactNormalTerminationTester:

Public Member Functions

virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 Implementation of the initialization method that has to be overloaded by for each derived class. More...
 
virtual bool InitializeSolve ()
 Method for initializing for the next iterative solve. More...
 
virtual ETerminationTest TestTermination (Index ndim, const Number *sol, const Number *resid, Index iter, Number norm2_rhs)
 This method checks if the current soltion of the iterative linear solver is good enough (by returning the corresponding satisfied termination test), or if the Hessian should be modified. More...
 
virtual void Clear ()
 This method can be called after the Solve is over and we can delete anything that has been allocated to free memory. More...
 
virtual Index GetSolverIterations () const
 Return the number of iterative solver iteration from the most recent solve. More...
 
void Set_c_Avc_norm_cauchy (Number c_Avc_norm_cauchy)
 Method for setting the normal problem objective function value at the Cauchy step. More...
 
/Destructor
 InexactNormalTerminationTester ()
 Default constructor. More...
 
virtual ~InexactNormalTerminationTester ()
 Default destructor. More...
 
- Public Member Functions inherited from Ipopt::IterativeSolverTerminationTester
const JournalistGetJnlst () const
 An easy way to get the journalist if accessed from the outside. More...
 
 IterativeSolverTerminationTester ()
 Default constructor. More...
 
virtual ~IterativeSolverTerminationTester ()
 Default destructor. More...
 
- Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
bool Initialize (const Journalist &jnlst, IpoptNLP &ip_nlp, IpoptData &ip_data, IpoptCalculatedQuantities &ip_cq, const OptionsList &options, const std::string &prefix)
 This method is called every time the algorithm starts again - it is used to reset any internal state. More...
 
bool ReducedInitialize (const Journalist &jnlst, const OptionsList &options, const std::string &prefix)
 Reduced version of the Initialize method, which does not require special Ipopt information. More...
 
 AlgorithmStrategyObject ()
 Default Constructor. More...
 
virtual ~AlgorithmStrategyObject ()
 Default Destructor. 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
 

Static Public Member Functions

static void RegisterOptions (SmartPtr< RegisteredOptions > roptions)
 Methods for IpoptType. More...
 

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.

InexactNormalTerminationTesteroperator= (const InexactNormalTerminationTester &)
 Overloaded Equals Operator. More...
 

Private Attributes

Number c_Avc_norm_cauchy_
 Value of normal problem objective function achived by the Cauchy step. More...
 
Index last_iter_
 Last iterative solver iteration counter. More...
 
Algorithmic options
Number inexact_normal_tol_
 Desired reduction of residual. More...
 
Index inexact_normal_max_iter_
 Maximal number of iterative solve iterations. More...
 
bool requires_scaling_
 Is set to true if the linear system is scaled via slacks. More...
 

Additional Inherited Members

- Public Types inherited from Ipopt::IterativeSolverTerminationTester
enum  ETerminationTest {
  CONTINUE, TEST_1_SATISFIED, TEST_2_SATISFIED, TEST_3_SATISFIED,
  MODIFY_HESSIAN, OTHER_SATISFIED
}
 Enum to report result of termination test. More...
 
- Protected Member Functions inherited from Ipopt::IterativeSolverTerminationTester
void GetVectors (Index ndim, const Number *array, SmartPtr< const Vector > &comp_x, SmartPtr< const Vector > &comp_s, SmartPtr< const Vector > &comp_c, SmartPtr< const Vector > &comp_d)
 Method for copying a long augmented system array into Vectors in Ipopt notation. More...
 
InexactDataInexData ()
 Method to easily access Inexact data. More...
 
InexactCqInexCq ()
 Method to easily access Inexact calculated quantities. More...
 
- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

This class implements the termination tests for the primal-dual system.

Definition at line 20 of file IpInexactNormalTerminationTester.hpp.

Constructor & Destructor Documentation

Ipopt::InexactNormalTerminationTester::InexactNormalTerminationTester ( )

Default constructor.

virtual Ipopt::InexactNormalTerminationTester::~InexactNormalTerminationTester ( )
virtual

Default destructor.

Member Function Documentation

virtual bool Ipopt::InexactNormalTerminationTester::InitializeImpl ( const OptionsList options,
const std::string &  prefix 
)
virtual

Implementation of the initialization method that has to be overloaded by for each derived class.

Implements Ipopt::IterativeSolverTerminationTester.

static void Ipopt::InexactNormalTerminationTester::RegisterOptions ( SmartPtr< RegisteredOptions roptions)
static

Methods for IpoptType.

virtual bool Ipopt::InexactNormalTerminationTester::InitializeSolve ( )
virtual

Method for initializing for the next iterative solve.

This must be call before the test methods are called.

Implements Ipopt::IterativeSolverTerminationTester.

virtual ETerminationTest Ipopt::InexactNormalTerminationTester::TestTermination ( Index  ndim,
const Number sol,
const Number resid,
Index  iter,
Number  norm2_rhs 
)
virtual

This method checks if the current soltion of the iterative linear solver is good enough (by returning the corresponding satisfied termination test), or if the Hessian should be modified.

The input is the dimension of the augmented system, the current solution vector of the augmented system, the current residual vector.

Implements Ipopt::IterativeSolverTerminationTester.

virtual void Ipopt::InexactNormalTerminationTester::Clear ( )
virtual

This method can be called after the Solve is over and we can delete anything that has been allocated to free memory.

Implements Ipopt::IterativeSolverTerminationTester.

virtual Index Ipopt::InexactNormalTerminationTester::GetSolverIterations ( ) const
inlinevirtual

Return the number of iterative solver iteration from the most recent solve.

Implements Ipopt::IterativeSolverTerminationTester.

Definition at line 63 of file IpInexactNormalTerminationTester.hpp.

void Ipopt::InexactNormalTerminationTester::Set_c_Avc_norm_cauchy ( Number  c_Avc_norm_cauchy)
inline

Method for setting the normal problem objective function value at the Cauchy step.

This must be called by the Dogleg object.

Definition at line 71 of file IpInexactNormalTerminationTester.hpp.

InexactNormalTerminationTester& Ipopt::InexactNormalTerminationTester::operator= ( const InexactNormalTerminationTester )
private

Overloaded Equals Operator.

Member Data Documentation

Number Ipopt::InexactNormalTerminationTester::inexact_normal_tol_
private

Desired reduction of residual.

Definition at line 92 of file IpInexactNormalTerminationTester.hpp.

Index Ipopt::InexactNormalTerminationTester::inexact_normal_max_iter_
private

Maximal number of iterative solve iterations.

Definition at line 94 of file IpInexactNormalTerminationTester.hpp.

bool Ipopt::InexactNormalTerminationTester::requires_scaling_
private

Is set to true if the linear system is scaled via slacks.

Definition at line 96 of file IpInexactNormalTerminationTester.hpp.

Number Ipopt::InexactNormalTerminationTester::c_Avc_norm_cauchy_
private

Value of normal problem objective function achived by the Cauchy step.

This must be set by the Dogleg step object.

Definition at line 101 of file IpInexactNormalTerminationTester.hpp.

Index Ipopt::InexactNormalTerminationTester::last_iter_
private

Last iterative solver iteration counter.

Definition at line 104 of file IpInexactNormalTerminationTester.hpp.


The documentation for this class was generated from the following file: