Ipopt Documentation  
Ipopt::StdStepCalculator Class Reference

#include <SensStdStepCalc.hpp>

+ Inheritance diagram for Ipopt::StdStepCalculator:

Public Member Functions

 StdStepCalculator (SmartPtr< SchurData > ift_data, SmartPtr< SensBacksolver > backsolver)
 
virtual ~StdStepCalculator ()
 
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 Step (DenseVector &delta_u, IteratesVector &sol)
 This is the main algorithmic function of this class. More...
 
bool BoundCheck (IteratesVector &sol, std::vector< Index > &x_bound_violations_idx, std::vector< Number > &x_bound_violations_du)
 
virtual SmartPtr< IteratesVectorGetSensitivityVector (void)
 return the sensitivity vector More...
 
- Public Member Functions inherited from Ipopt::SensitivityStepCalculator
 SensitivityStepCalculator ()
 
virtual ~SensitivityStepCalculator ()
 
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...
 
bool Do_Boundcheck () const
 
void SetSchurDriver (SmartPtr< SchurDriver > driver)
 
SmartPtr< SchurDriverDriver ()
 
virtual bool Step (DenseVector &delta_u, IteratesVector &sol)=0
 This is the main algorithmic function of this class. More...
 
virtual SmartPtr< IteratesVectorGetSensitivityVector ()=0
 return the sensitivity vector 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 ()
 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 Attributes

SmartPtr< SchurDataift_data_
 
SmartPtr< SensBacksolverbacksolver_
 
Number bound_eps_
 
bool kkt_residuals_
 
SmartPtr< IteratesVectorSensitivityVector
 

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
virtual bool InitializeImpl (const OptionsList &options, const std::string &prefix)=0
 Implementation of the initialization method that has to be overloaded by for each derived class. More...
 
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Definition at line 20 of file SensStdStepCalc.hpp.

Constructor & Destructor Documentation

◆ StdStepCalculator()

Ipopt::StdStepCalculator::StdStepCalculator ( SmartPtr< SchurData ift_data,
SmartPtr< SensBacksolver backsolver 
)

◆ ~StdStepCalculator()

virtual Ipopt::StdStepCalculator::~StdStepCalculator ( )
virtual

Member Function Documentation

◆ InitializeImpl()

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

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

Reimplemented from Ipopt::SensitivityStepCalculator.

◆ Step()

virtual bool Ipopt::StdStepCalculator::Step ( DenseVector delta_u,
IteratesVector sol 
)
virtual

This is the main algorithmic function of this class.

It calculates a step using its SchurDriver, checks bounds, and returns it

Implements Ipopt::SensitivityStepCalculator.

◆ BoundCheck()

bool Ipopt::StdStepCalculator::BoundCheck ( IteratesVector sol,
std::vector< Index > &  x_bound_violations_idx,
std::vector< Number > &  x_bound_violations_du 
)

◆ GetSensitivityVector()

virtual SmartPtr< IteratesVector > Ipopt::StdStepCalculator::GetSensitivityVector ( void  )
inlinevirtual

return the sensitivity vector

Implements Ipopt::SensitivityStepCalculator.

Definition at line 51 of file SensStdStepCalc.hpp.

Member Data Documentation

◆ ift_data_

SmartPtr<SchurData> Ipopt::StdStepCalculator::ift_data_
private

Definition at line 57 of file SensStdStepCalc.hpp.

◆ backsolver_

SmartPtr<SensBacksolver> Ipopt::StdStepCalculator::backsolver_
private

Definition at line 58 of file SensStdStepCalc.hpp.

◆ bound_eps_

Number Ipopt::StdStepCalculator::bound_eps_
private

Definition at line 59 of file SensStdStepCalc.hpp.

◆ kkt_residuals_

bool Ipopt::StdStepCalculator::kkt_residuals_
private

Definition at line 60 of file SensStdStepCalc.hpp.

◆ SensitivityVector

SmartPtr<IteratesVector> Ipopt::StdStepCalculator::SensitivityVector
private

Definition at line 62 of file SensStdStepCalc.hpp.


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