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

#include <IpSlackBasedTSymScalingMethod.hpp>

Inheritance diagram for Ipopt::SlackBasedTSymScalingMethod:

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
	SlackBasedTSymScalingMethod ()

virtual	~SlackBasedTSymScalingMethod ()

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.
	SlackBasedTSymScalingMethod (const SlackBasedTSymScalingMethod &)
	Copy Constructor.

void	operator= (const SlackBasedTSymScalingMethod &)
	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

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

The scaling is only considering the current slacks.

Definition at line 21 of file IpSlackBasedTSymScalingMethod.hpp.

Constructor & Destructor Documentation

◆ SlackBasedTSymScalingMethod() [1/2]

Ipopt::SlackBasedTSymScalingMethod::SlackBasedTSymScalingMethod ( )

inline

Definition at line 26 of file IpSlackBasedTSymScalingMethod.hpp.

◆ ~SlackBasedTSymScalingMethod()

virtual Ipopt::SlackBasedTSymScalingMethod::~SlackBasedTSymScalingMethod ( )

inlinevirtual

Definition at line 29 of file IpSlackBasedTSymScalingMethod.hpp.

◆ SlackBasedTSymScalingMethod() [2/2]

Ipopt::SlackBasedTSymScalingMethod::SlackBasedTSymScalingMethod ( const SlackBasedTSymScalingMethod & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

virtual bool Ipopt::SlackBasedTSymScalingMethod::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::SlackBasedTSymScalingMethod::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::SlackBasedTSymScalingMethod::operator= ( const SlackBasedTSymScalingMethod & )

private

Default Assignment Operator.

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

src/Algorithm/LinearSolvers/IpSlackBasedTSymScalingMethod.hpp

Public Member Functions

Private Member Functions

Additional Inherited Members