Ipopt Documentation  
Ipopt::Mc19TSymScalingMethod Class Reference

Class for the method for computing scaling factors for symmetric matrices in triplet format, using MC19. More...

#include <IpMc19TSymScalingMethod.hpp>

+ Inheritance diagram for Ipopt::Mc19TSymScalingMethod:

Public Member Functions

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

 Mc19TSymScalingMethod (const Mc19TSymScalingMethod &)
 Copy Constructor. More...
 
void operator= (const Mc19TSymScalingMethod &)
 Default Assignment Operator. More...
 

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, using MC19.

Definition at line 19 of file IpMc19TSymScalingMethod.hpp.

Constructor & Destructor Documentation

◆ Mc19TSymScalingMethod() [1/2]

Ipopt::Mc19TSymScalingMethod::Mc19TSymScalingMethod ( )
inline

Definition at line 24 of file IpMc19TSymScalingMethod.hpp.

◆ ~Mc19TSymScalingMethod()

virtual Ipopt::Mc19TSymScalingMethod::~Mc19TSymScalingMethod ( )
inlinevirtual

Definition at line 27 of file IpMc19TSymScalingMethod.hpp.

◆ Mc19TSymScalingMethod() [2/2]

Ipopt::Mc19TSymScalingMethod::Mc19TSymScalingMethod ( const Mc19TSymScalingMethod )
private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::Mc19TSymScalingMethod::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::Mc19TSymScalingMethod::ComputeSymTScalingFactors ( Index  n,
Index  nnz,
const ipfint airn,
const ipfint ajcn,
const double *  a,
double *  scaling_factors 
)
virtual

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

◆ operator=()

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

Default Assignment Operator.


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