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
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
	Mc19TSymScalingMethod (SmartPtr< LibraryLoader > hslloader_)
virtual	~Mc19TSymScalingMethod ()
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

Static Public Member Functions
static void	SetFunctions ()
	set MC19 function to use for every instantiation of this class
static IPOPT_DECL_MC19A *	GetMC19A ()
	get MC19A function that has been set via SetFunctions

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.
void	operator= (const Mc19TSymScalingMethod &)
	Default Assignment Operator.

Private Attributes
MC19 function pointer
SmartPtr< LibraryLoader >	hslloader
IPOPT_DECL_MC19A *	mc19a

Additional Inherited Members
Protected Member Functions inherited from Ipopt::AlgorithmStrategyObject
const Journalist &	Jnlst () const
IpoptNLP &	IpNLP () const
IpoptData &	IpData () const
IpoptCalculatedQuantities &	IpCq () 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 35 of file IpMc19TSymScalingMethod.hpp.

Constructor & Destructor Documentation

Mc19TSymScalingMethod() [1/2]

Ipopt::Mc19TSymScalingMethod::Mc19TSymScalingMethod ( SmartPtr< LibraryLoader >  hslloader_ )

inline

Parameters

hslloader_

Since

3.14.0

Definition at line 40 of file IpMc19TSymScalingMethod.hpp.

~Mc19TSymScalingMethod()

virtual Ipopt::Mc19TSymScalingMethod::~Mc19TSymScalingMethod ( )

inlinevirtual

Definition at line 46 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 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.

SetFunctions()

static void Ipopt::Mc19TSymScalingMethod::SetFunctions ( )

static

set MC19 function to use for every instantiation of this class

Since

3.14.0

GetMC19A()

static IPOPT_DECL_MC19A * Ipopt::Mc19TSymScalingMethod::GetMC19A ( )

static

get MC19A function that has been set via SetFunctions

this does not return a MC19A that has been linked in or loaded from a library at runtime

Since

3.14.0

operator=()

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

private

Default Assignment Operator.

Member Data Documentation

hslloader

SmartPtr<LibraryLoader> Ipopt::Mc19TSymScalingMethod::hslloader

private

Definition at line 99 of file IpMc19TSymScalingMethod.hpp.

mc19a

IPOPT_DECL_MC19A* Ipopt::Mc19TSymScalingMethod::mc19a

private

Definition at line 101 of file IpMc19TSymScalingMethod.hpp.

---

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

• src/Algorithm/LinearSolvers/IpMc19TSymScalingMethod.hpp