Ipopt  3.11.9
Public Member Functions | Private Attributes | List of all members
Ipopt::SensAlgorithm Class Reference

#include <SensAlgorithm.hpp>

+ Inheritance diagram for Ipopt::SensAlgorithm:

Public Member Functions

 SensAlgorithm (std::vector< SmartPtr< SchurDriver > > &driver_vec, SmartPtr< SensitivityStepCalculator > sens_step_calc, SmartPtr< Measurement > measurement, Index n_sens_steps)
 This is the interface for the actual controller. More...
 
virtual ~SensAlgorithm ()
 
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...
 
SensAlgorithmExitStatus Run ()
 Main loop: Wait for new measurement, Get new step, maybe deal with bounds, see to it that everything happens in the required timeframe. More...
 
- Public Member Functions inherited from Ipopt::AlgorithmStrategyObject
 AlgorithmStrategyObject ()
 Default Constructor. More...
 
virtual ~AlgorithmStrategyObject ()
 Default Destructor. More...
 
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...
 
- 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

std::vector< SmartPtr< SchurDriver > > driver_vec_
 
SmartPtr< SensitivityStepCalculatorsens_step_calc_
 
SmartPtr< Measurementmeasurement_
 
Index n_sens_steps_
 

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 19 of file SensAlgorithm.hpp.

Constructor & Destructor Documentation

◆ SensAlgorithm()

Ipopt::SensAlgorithm::SensAlgorithm ( std::vector< SmartPtr< SchurDriver > > &  driver_vec,
SmartPtr< SensitivityStepCalculator sens_step_calc,
SmartPtr< Measurement measurement,
Index  n_sens_steps 
)

This is the interface for the actual controller.

It handles Data input to the controller (measurement) and returns controls

◆ ~SensAlgorithm()

virtual Ipopt::SensAlgorithm::~SensAlgorithm ( )
virtual

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::SensAlgorithm::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::AlgorithmStrategyObject.

◆ Run()

SensAlgorithmExitStatus Ipopt::SensAlgorithm::Run ( )

Main loop: Wait for new measurement, Get new step, maybe deal with bounds, see to it that everything happens in the required timeframe.

Member Data Documentation

◆ driver_vec_

std::vector< SmartPtr<SchurDriver> > Ipopt::SensAlgorithm::driver_vec_
private

Definition at line 43 of file SensAlgorithm.hpp.

◆ sens_step_calc_

SmartPtr<SensitivityStepCalculator> Ipopt::SensAlgorithm::sens_step_calc_
private

Definition at line 44 of file SensAlgorithm.hpp.

◆ measurement_

SmartPtr<Measurement> Ipopt::SensAlgorithm::measurement_
private

Definition at line 45 of file SensAlgorithm.hpp.

◆ n_sens_steps_

Index Ipopt::SensAlgorithm::n_sens_steps_
private

Definition at line 46 of file SensAlgorithm.hpp.


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