Base class for the method for computing scaling factors for symmetric matrices in triplet format. More...

#include <IpTSymScalingMethod.hpp>

Inheritance diagram for Ipopt::TSymScalingMethod:

Public Member Functions
virtual bool	InitializeImpl (const OptionsList &options, const std::string &prefix)=0
	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)=0
	Method for computing the symmetric scaling factors, given the symmetric matrix in triplet (MA27) format.

Constructor/Destructor
	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.
	TSymScalingMethod (const TSymScalingMethod &)
	Copy Constructor.

void	operator= (const TSymScalingMethod &)
	Default Assignment Operator.

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

Base class for the method for computing scaling factors for symmetric matrices in triplet format.

Definition at line 21 of file IpTSymScalingMethod.hpp.

Constructor & Destructor Documentation

◆ TSymScalingMethod() [1/2]

Ipopt::TSymScalingMethod::TSymScalingMethod ( )

inline

Definition at line 26 of file IpTSymScalingMethod.hpp.

◆ ~TSymScalingMethod()

Ipopt::TSymScalingMethod::~TSymScalingMethod ( )

inline

Definition at line 29 of file IpTSymScalingMethod.hpp.

◆ TSymScalingMethod() [2/2]

Ipopt::TSymScalingMethod::TSymScalingMethod ( const TSymScalingMethod & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::TSymScalingMethod::InitializeImpl	(	const OptionsList &	options,
		const std::string &	prefix
	)

pure virtual

Implementation of the initialization method that has to be overloaded by for each derived class.

Implements Ipopt::AlgorithmStrategyObject.

Implemented in Ipopt::InexactTSymScalingMethod, Ipopt::Mc19TSymScalingMethod, and Ipopt::SlackBasedTSymScalingMethod.

◆ ComputeSymTScalingFactors()

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

pure virtual

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

Implemented in Ipopt::InexactTSymScalingMethod, Ipopt::Mc19TSymScalingMethod, and Ipopt::SlackBasedTSymScalingMethod.

◆ operator=()

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

private

Default Assignment Operator.

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

src/Algorithm/LinearSolvers/IpTSymScalingMethod.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members