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

Class for the method for computing scaling factors for symmetric matrices in triplet format, specifically for the inexaxct algorithm. More...

#include <IpInexactTSymScalingMethod.hpp>

+ Inheritance diagram for Ipopt::InexactTSymScalingMethod:

Public Member Functions

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 ComputeSymTScalingFactors (Index n, Index nnz, const Index *airn, const Index *ajcn, const Number *a, Number *scaling_factors)
 Method for computing the symmetric scaling factors, given the symmetric matrix in triplet (MA27) format.
 
Constructor/Destructor
 InexactTSymScalingMethod ()
 
virtual ~InexactTSymScalingMethod ()
 
- Public Member Functions inherited from Ipopt::TSymScalingMethod
 TSymScalingMethod ()
 
 ~TSymScalingMethod ()
 
- 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

Default Compiler Generated Methods (Hidden to avoid

implicit creation/calling).

These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.

 InexactTSymScalingMethod (const InexactTSymScalingMethod &)
 Copy Constructor.
 
void operator= (const InexactTSymScalingMethod &)
 Overloaded Assignment Operator.
 
InexactCqInexCq ()
 Method to easily access Inexact calculated quantities.
 

Additional Inherited Members

- Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const JournalistJnlst () const
 
IpoptNLPIpNLP () const
 
IpoptDataIpData () const
 
IpoptCalculatedQuantitiesIpCq () const
 
bool HaveIpData () const
 

Detailed Description

Class for the method for computing scaling factors for symmetric matrices in triplet format, specifically for the inexaxct algorithm.

The scaling is only considering the current slacks.

Definition at line 22 of file IpInexactTSymScalingMethod.hpp.

Constructor & Destructor Documentation

◆ InexactTSymScalingMethod() [1/2]

Ipopt::InexactTSymScalingMethod::InexactTSymScalingMethod ( )
inline

Definition at line 27 of file IpInexactTSymScalingMethod.hpp.

◆ ~InexactTSymScalingMethod()

virtual Ipopt::InexactTSymScalingMethod::~InexactTSymScalingMethod ( )
inlinevirtual

Definition at line 30 of file IpInexactTSymScalingMethod.hpp.

◆ InexactTSymScalingMethod() [2/2]

Ipopt::InexactTSymScalingMethod::InexactTSymScalingMethod ( const InexactTSymScalingMethod )
private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

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

◆ ComputeSymTScalingFactors()

virtual bool Ipopt::InexactTSymScalingMethod::ComputeSymTScalingFactors ( Index  n,
Index  nnz,
const Index airn,
const Index ajcn,
const Number a,
Number scaling_factors 
)
virtual

Method for computing the symmetric scaling factors, given the symmetric matrix in triplet (MA27) format.

Implements Ipopt::TSymScalingMethod.

◆ operator=()

void Ipopt::InexactTSymScalingMethod::operator= ( const InexactTSymScalingMethod )
private

Overloaded Assignment Operator.

◆ InexCq()

InexactCq & Ipopt::InexactTSymScalingMethod::InexCq ( )
inlineprivate

Method to easily access Inexact calculated quantities.

Definition at line 72 of file IpInexactTSymScalingMethod.hpp.


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