Ipopt Documentation  
No Matches
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.
virtual bool Step (DenseVector &delta_u, IteratesVector &sol)
 This is the main algorithmic function of this class.
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
- Public Member Functions inherited from Ipopt::SensitivityStepCalculator
 SensitivityStepCalculator ()
virtual ~SensitivityStepCalculator ()
bool Do_Boundcheck () const
void SetSchurDriver (SmartPtr< SchurDriver > driver)
SmartPtr< SchurDriverDriver ()
- 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 ()
- 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
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 ( )

Member Function Documentation

◆ InitializeImpl()

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

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 

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  )

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_

Definition at line 57 of file SensStdStepCalc.hpp.

◆ backsolver_

SmartPtr<SensBacksolver> Ipopt::StdStepCalculator::backsolver_

Definition at line 58 of file SensStdStepCalc.hpp.

◆ bound_eps_

Number Ipopt::StdStepCalculator::bound_eps_

Definition at line 59 of file SensStdStepCalc.hpp.

◆ kkt_residuals_

bool Ipopt::StdStepCalculator::kkt_residuals_

Definition at line 60 of file SensStdStepCalc.hpp.

◆ SensitivityVector

SmartPtr<IteratesVector> Ipopt::StdStepCalculator::SensitivityVector

Definition at line 62 of file SensStdStepCalc.hpp.

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