Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Ipopt::SchurDriver Class Referenceabstract

#include <SensSchurDriver.hpp>

+ Inheritance diagram for Ipopt::SchurDriver:

Public Member Functions

 SchurDriver (SmartPtr< PCalculator > pcalc, SmartPtr< SchurData > data_B)
 This class is the interface for any class that deals with the Schur matrix from the point when it is constructed by the PCalculator to the solution against one vector. More...
 
virtual ~SchurDriver ()
 
virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)
 Overloaded from AlgorithmStrategyObject. More...
 
virtual SmartPtr< const SchurDatadata_A () const
 Const accessor methods to the SchurData for for the derived classes. More...
 
virtual SmartPtr< const SchurDatadata_B () const
 
virtual SmartPtr< SchurDatadata_A_nonconst ()
 
virtual SmartPtr< SchurDatadata_B_nonconst ()
 
virtual SmartPtr< const
PCalculator
pcalc () const
 
virtual SmartPtr< PCalculatorpcalc_nonconst ()
 
virtual bool SchurBuild ()=0
 Sets the Data for which this SchurMatrix will be built. More...
 
virtual bool SchurFactorize ()=0
 Calls the factorization routine for the SchurMatrix. More...
 
virtual bool SchurSolve (SmartPtr< IteratesVector > lhs, SmartPtr< const IteratesVector > rhs, SmartPtr< Vector > delta_u, SmartPtr< IteratesVector > sol=NULL)=0
 Performs a backsolve on S and K. 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
 

Private Member Functions

 SchurDriver ()
 
Performs a backsolve on S and K; calls the latter with sol=K^(-1)*r_s=0

virtual bool SchurSolve(SmartPtr<IteratesVector> lhs, SmartPtr<const IteratesVector> rhs, SmartPtr<Vector> delta_u) =0; More...

 

Private Attributes

SmartPtr< PCalculatorpcalc_
 
SmartPtr< SchurDatadata_B_
 

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Definition at line 18 of file SensSchurDriver.hpp.

Constructor & Destructor Documentation

Ipopt::SchurDriver::SchurDriver ( SmartPtr< PCalculator pcalc,
SmartPtr< SchurData data_B 
)
inline

This class is the interface for any class that deals with the Schur matrix from the point when it is constructed by the PCalculator to the solution against one vector.

Specific implementations may also incorporate the treatment of adding rows/cols (like QPSchur).

The computations done by this class are

  1. Solve $S \Delta\nu = r_s$
  2. Solve $K\Delta s = ... - \Delta nu$ (really?)

Definition at line 31 of file SensSchurDriver.hpp.

virtual Ipopt::SchurDriver::~SchurDriver ( )
inlinevirtual

Definition at line 39 of file SensSchurDriver.hpp.

Ipopt::SchurDriver::SchurDriver ( )
inlineprivate

Performs a backsolve on S and K; calls the latter with sol=K^(-1)*r_s=0

virtual bool SchurSolve(SmartPtr<IteratesVector> lhs, SmartPtr<const IteratesVector> rhs, SmartPtr<Vector> delta_u) =0;

Definition at line 102 of file SensSchurDriver.hpp.

Member Function Documentation

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

Overloaded from AlgorithmStrategyObject.

Implements Ipopt::AlgorithmStrategyObject.

Definition at line 44 of file SensSchurDriver.hpp.

virtual SmartPtr<const SchurData> Ipopt::SchurDriver::data_A ( ) const
inlinevirtual

Const accessor methods to the SchurData for for the derived classes.

Definition at line 51 of file SensSchurDriver.hpp.

virtual SmartPtr<const SchurData> Ipopt::SchurDriver::data_B ( ) const
inlinevirtual

Definition at line 56 of file SensSchurDriver.hpp.

virtual SmartPtr<SchurData> Ipopt::SchurDriver::data_A_nonconst ( )
inlinevirtual

Definition at line 61 of file SensSchurDriver.hpp.

virtual SmartPtr<SchurData> Ipopt::SchurDriver::data_B_nonconst ( )
inlinevirtual

Definition at line 66 of file SensSchurDriver.hpp.

virtual SmartPtr<const PCalculator> Ipopt::SchurDriver::pcalc ( ) const
inlinevirtual

Definition at line 71 of file SensSchurDriver.hpp.

virtual SmartPtr<PCalculator> Ipopt::SchurDriver::pcalc_nonconst ( )
inlinevirtual

Definition at line 76 of file SensSchurDriver.hpp.

virtual bool Ipopt::SchurDriver::SchurBuild ( )
pure virtual

Sets the Data for which this SchurMatrix will be built.

Creates the SchurMatrix from B and P

Implemented in Ipopt::DenseGenSchurDriver.

virtual bool Ipopt::SchurDriver::SchurFactorize ( )
pure virtual

Calls the factorization routine for the SchurMatrix.

Implemented in Ipopt::DenseGenSchurDriver.

virtual bool Ipopt::SchurDriver::SchurSolve ( SmartPtr< IteratesVector lhs,
SmartPtr< const IteratesVector rhs,
SmartPtr< Vector delta_u,
SmartPtr< IteratesVector sol = NULL 
)
pure virtual

Performs a backsolve on S and K.

Implemented in Ipopt::DenseGenSchurDriver.

Member Data Documentation

SmartPtr<PCalculator> Ipopt::SchurDriver::pcalc_
private

Definition at line 106 of file SensSchurDriver.hpp.

SmartPtr<SchurData> Ipopt::SchurDriver::data_B_
private

Definition at line 108 of file SensSchurDriver.hpp.


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