Ipopt Documentation  
Loading...
Searching...
No Matches
Ipopt::MetadataMeasurement Class Reference

#include <SensMetadataMeasurement.hpp>

Inheritance diagram for Ipopt::MetadataMeasurement:

Public Member Functions

 MetadataMeasurement ()
virtual ~MetadataMeasurement ()
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 std::vector< IndexGetInitialEqConstraints ()
 This function returns a std::vector holding the indices in IteratesVector of the equations that are to be "slacked" to free the initial values for sIPOPT.
virtual SmartPtr< DenseVectorGetMeasurement (Index measurement_number)
 This function returns delta_u.
virtual void SetSolution (Index measurement_number, SmartPtr< IteratesVector > sol)
 This function does whatever the measurement machine does with the solution of the SensAlgorithm.
virtual std::vector< IndexGetIntegerSuffix (std::string suffix_string)
Public Member Functions inherited from Ipopt::Measurement
 Measurement ()
 This class provides an abstraction for the measurements of the states coming in and the solutions of the controller.
virtual ~Measurement ()
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
Public Member Functions inherited from Ipopt::SuffixHandler
 SuffixHandler ()
virtual ~SuffixHandler ()
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.

Private Attributes

Index n_idx_
 Number of sens_indices.
SmartPtr< const DenseVectorSpacex_owner_space_
 owner space of x
SmartPtr< const DenseVectorSpaces_owner_space_
 owner space of s
SmartPtr< const DenseVectorSpacey_c_owner_space_
 owner space of y_c
SmartPtr< const DenseVectorSpacey_d_owner_space_
 owner space of y_d
SmartPtr< const DenseVectorSpacez_L_owner_space_
 owner space of z_L
SmartPtr< const DenseVectorSpacez_U_owner_space_
 owner space of z_U

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 17 of file SensMetadataMeasurement.hpp.

Constructor & Destructor Documentation

◆ MetadataMeasurement()

Ipopt::MetadataMeasurement::MetadataMeasurement ( )

◆ ~MetadataMeasurement()

virtual Ipopt::MetadataMeasurement::~MetadataMeasurement ( )
virtual

Member Function Documentation

◆ InitializeImpl()

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

◆ GetInitialEqConstraints()

virtual std::vector< Index > Ipopt::MetadataMeasurement::GetInitialEqConstraints ( )
virtual

This function returns a std::vector holding the indices in IteratesVector of the equations that are to be "slacked" to free the initial values for sIPOPT.

This std::vector is used in the construction of the A-SchurData for the Schur Decomposition.

Implements Ipopt::Measurement.

◆ GetMeasurement()

virtual SmartPtr< DenseVector > Ipopt::MetadataMeasurement::GetMeasurement ( Index measurement_number)
virtual

This function returns delta_u.

It should use the values of IpData().trial()->x()

Implements Ipopt::Measurement.

◆ SetSolution()

virtual void Ipopt::MetadataMeasurement::SetSolution ( Index measurement_number,
SmartPtr< IteratesVector > sol )
virtual

This function does whatever the measurement machine does with the solution of the SensAlgorithm.

Implements Ipopt::Measurement.

◆ GetIntegerSuffix()

virtual std::vector< Index > Ipopt::MetadataMeasurement::GetIntegerSuffix ( std::string suffix_string)
virtual

Implements Ipopt::SuffixHandler.

Member Data Documentation

◆ n_idx_

Index Ipopt::MetadataMeasurement::n_idx_
private

Number of sens_indices.

Definition at line 51 of file SensMetadataMeasurement.hpp.

◆ x_owner_space_

SmartPtr<const DenseVectorSpace> Ipopt::MetadataMeasurement::x_owner_space_
private

owner space of x

Definition at line 54 of file SensMetadataMeasurement.hpp.

◆ s_owner_space_

SmartPtr<const DenseVectorSpace> Ipopt::MetadataMeasurement::s_owner_space_
private

owner space of s

Definition at line 56 of file SensMetadataMeasurement.hpp.

◆ y_c_owner_space_

SmartPtr<const DenseVectorSpace> Ipopt::MetadataMeasurement::y_c_owner_space_
private

owner space of y_c

Definition at line 58 of file SensMetadataMeasurement.hpp.

◆ y_d_owner_space_

SmartPtr<const DenseVectorSpace> Ipopt::MetadataMeasurement::y_d_owner_space_
private

owner space of y_d

Definition at line 60 of file SensMetadataMeasurement.hpp.

◆ z_L_owner_space_

SmartPtr<const DenseVectorSpace> Ipopt::MetadataMeasurement::z_L_owner_space_
private

owner space of z_L

Definition at line 62 of file SensMetadataMeasurement.hpp.

◆ z_U_owner_space_

SmartPtr<const DenseVectorSpace> Ipopt::MetadataMeasurement::z_U_owner_space_
private

owner space of z_U

Definition at line 64 of file SensMetadataMeasurement.hpp.


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