Ipopt::SchurDriver Class Reference

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...

#include <SensSchurDriver.hpp>

Inheritance diagram for Ipopt::SchurDriver:

Public Member Functions
	SchurDriver (SmartPtr< PCalculator > pcalc, SmartPtr< SchurData > data_B)
virtual	~SchurDriver ()
virtual bool	InitializeImpl (const OptionsList &, const std::string &)
	Implementation of the initialization method that has to be overloaded by for each derived class.
virtual SmartPtr< const SchurData >	data_A () const
	Const accessor methods to the SchurData for for the derived classes.
virtual SmartPtr< const SchurData >	data_B () const
virtual SmartPtr< SchurData >	data_A_nonconst ()
virtual SmartPtr< SchurData >	data_B_nonconst ()
virtual SmartPtr< const PCalculator >	pcalc () const
virtual SmartPtr< PCalculator >	pcalc_nonconst ()
virtual bool	SchurBuild ()=0
	Creates the SchurMatrix from B and P.
virtual bool	SchurFactorize ()=0
	Calls the factorization routine for the SchurMatrix.
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.
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.
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.
	AlgorithmStrategyObject ()
	Default Constructor.
virtual	~AlgorithmStrategyObject ()
	Destructor.
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 ()

Private Attributes
SmartPtr< PCalculator >	pcalc_
SmartPtr< SchurData >	data_B_

Additional Inherited Members
Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const Journalist &	Jnlst () const
IpoptNLP &	IpNLP () const
IpoptData &	IpData () const
IpoptCalculatedQuantities &	IpCq () const
bool	HaveIpData () const

Detailed Description

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 29 of file SensSchurDriver.hpp.

Constructor & Destructor Documentation

SchurDriver() [1/2]

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

inline

Definition at line 33 of file SensSchurDriver.hpp.

~SchurDriver()

virtual Ipopt::SchurDriver::~SchurDriver ( )

inlinevirtual

Definition at line 41 of file SensSchurDriver.hpp.

SchurDriver() [2/2]

Ipopt::SchurDriver::SchurDriver ( )

inlineprivate

Definition at line 108 of file SensSchurDriver.hpp.

Member Function Documentation

InitializeImpl()

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

inlinevirtual

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

Implements Ipopt::AlgorithmStrategyObject.

Definition at line 44 of file SensSchurDriver.hpp.

data_A()

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

inlinevirtual

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

Definition at line 53 of file SensSchurDriver.hpp.

data_B()

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

inlinevirtual

Definition at line 58 of file SensSchurDriver.hpp.

data_A_nonconst()

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

inlinevirtual

Definition at line 63 of file SensSchurDriver.hpp.

data_B_nonconst()

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

inlinevirtual

Definition at line 68 of file SensSchurDriver.hpp.

pcalc()

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

inlinevirtual

Definition at line 73 of file SensSchurDriver.hpp.

pcalc_nonconst()

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

inlinevirtual

Definition at line 78 of file SensSchurDriver.hpp.

SchurBuild()

virtual bool Ipopt::SchurDriver::SchurBuild ( )

pure virtual

Creates the SchurMatrix from B and P.

Implemented in Ipopt::DenseGenSchurDriver.

SchurFactorize()

virtual bool Ipopt::SchurDriver::SchurFactorize ( )

pure virtual

Calls the factorization routine for the SchurMatrix.

Implemented in Ipopt::DenseGenSchurDriver.

SchurSolve()

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.

sol is the vector K^(-1)*r_s which usually should have been computed before

Implemented in Ipopt::DenseGenSchurDriver.

Member Data Documentation

pcalc_

SmartPtr<PCalculator> Ipopt::SchurDriver::pcalc_

private

Definition at line 111 of file SensSchurDriver.hpp.

data_B_

SmartPtr<SchurData> Ipopt::SchurDriver::data_B_

private

Definition at line 113 of file SensSchurDriver.hpp.

---

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

• contrib/sIPOPT/src/SensSchurDriver.hpp