#include <IpMa86SolverInterface.hpp>

Inheritance diagram for Ipopt::Ma86SolverInterface:

Public Member Functions
	Ma86SolverInterface (SmartPtr< LibraryLoader > hslloader_)

	~Ma86SolverInterface ()

bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	Implementation of the initialization method that has to be overloaded by for each derived class.

Methods for requesting solution of the linear system.
ESymSolverStatus	InitializeStructure (Index dim, Index nonzeros, const Index ia, const Index ja)
	Method for initializing internal structures.

Number *	GetValuesArrayPtr ()
	Method returning an internal array into which the nonzero elements (in the same order as ja) will be stored by the calling routine before a call to MultiSolve with a new_matrix=true (or after a return of MultiSolve with SYMSOLV_CALL_AGAIN).

ESymSolverStatus	MultiSolve (bool new_matrix, const Index ia, const Index ja, Index nrhs, Number *rhs_vals, bool check_NegEVals, Index numberOfNegEVals)
	Solve operation for multiple right hand sides.

Index	NumberOfNegEVals () const
	Number of negative eigenvalues detected during last factorization.


bool	IncreaseQuality ()
	Request to increase quality of solution for next solve.

bool	ProvidesInertia () const
	Query whether inertia is computed by linear solver.

EMatrixFormat	MatrixFormat () const
	Query of requested matrix type that the linear solver understands.

Methods related to the detection of linearly dependent
rows in a matrix
bool	ProvidesDegeneracyDetection () const
	Query whether the indices of linearly dependent rows/columns can be determined by this linear solver.

ESymSolverStatus	DetermineDependentRows (const Index , const Index , std::list< Index > &)
	This method determines the list of row indices of the linearly dependent rows.

Public Member Functions inherited from Ipopt::SparseSymLinearSolverInterface
	SparseSymLinearSolverInterface ()

virtual	~SparseSymLinearSolverInterface ()

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	RegisterOptions (SmartPtr< RegisteredOptions > roptions)

static void	SetFunctions (IPOPT_DECL_MA86_DEFAULT_CONTROL(ma86_default_control), IPOPT_DECL_MA86_ANALYSE(ma86_analyse), IPOPT_DECL_MA86_FACTOR(ma86_factor), IPOPT_DECL_MA86_FACTOR_SOLVE(ma86_factor_solve), IPOPT_DECL_MA86_SOLVE(ma86_solve), IPOPT_DECL_MA86_FINALISE(ma86_finalise), IPOPT_DECL_MC68_DEFAULT_CONTROL(*mc68_default_control),)
	set MA86 and MC68 functions to use for every instantiation of this class

Private Types
enum	order_opts { ORDER_AUTO , ORDER_AMD , ORDER_METIS }

Private Attributes
int	ndim_
	Number of dimensions.

Number *	val_
	Storage for variables.

int	numneg_
	Number of negative pivots in last factorization.

int *	order_
	Fill reducing permutation.

void *	keep_
	Stores pointer to factors (only understood by Fortran code!)

bool	pivtol_changed_
	indicates if pivtol has been changed

struct ma86_control	control_

Number	umax_

int	ordering_

MA68 and MC68 function pointers
SmartPtr< LibraryLoader >	hslloader

IPOPT_DECL_MA86_DEFAULT_CONTROL *	ma86_default_control

IPOPT_DECL_MA86_ANALYSE *	ma86_analyse

IPOPT_DECL_MA86_FACTOR *	ma86_factor

IPOPT_DECL_MA86_FACTOR_SOLVE *	ma86_factor_solve

IPOPT_DECL_MA86_SOLVE *	ma86_solve

IPOPT_DECL_MA86_FINALISE *	ma86_finalise

IPOPT_DECL_MC68_DEFAULT_CONTROL *	mc68_default_control

IPOPT_DECL_MC68_ORDER *	mc68_order

Additional Inherited Members
Public Types inherited from Ipopt::SparseSymLinearSolverInterface
enum	EMatrixFormat { Triplet_Format , CSR_Format_0_Offset , CSR_Format_1_Offset , CSR_Full_Format_0_Offset , CSR_Full_Format_1_Offset }
	Enum to specify sparse matrix format. More...

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

Definition at line 95 of file IpMa86SolverInterface.hpp.

Member Enumeration Documentation

◆ order_opts

enum Ipopt::Ma86SolverInterface::order_opts

private

Enumerator
ORDER_AUTO
ORDER_AMD
ORDER_METIS

Definition at line 98 of file IpMa86SolverInterface.hpp.

Constructor & Destructor Documentation

◆ Ma86SolverInterface()

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

inline

Parameters

hslloader_

Since: 3.14.0

Definition at line 134 of file IpMa86SolverInterface.hpp.

◆ ~Ma86SolverInterface()

Ipopt::Ma86SolverInterface::~Ma86SolverInterface ( )

Member Function Documentation

◆ RegisterOptions()

static void Ipopt::Ma86SolverInterface::RegisterOptions ( SmartPtr< RegisteredOptions > roptions )

static

◆ SetFunctions()

static void Ipopt::Ma86SolverInterface::SetFunctions	(	IPOPT_DECL_MA86_DEFAULT_CONTROL *	ma86_default_control,
		IPOPT_DECL_MA86_ANALYSE *	ma86_analyse,
		IPOPT_DECL_MA86_FACTOR *	ma86_factor,
		IPOPT_DECL_MA86_FACTOR_SOLVE *	ma86_factor_solve,
		IPOPT_DECL_MA86_SOLVE *	ma86_solve,
		IPOPT_DECL_MA86_FINALISE *	ma86_finalise,
		IPOPT_DECL_MC68_DEFAULT_CONTROL *	mc68_default_control
	)

static

set MA86 and MC68 functions to use for every instantiation of this class

Since: 3.14.0

◆ InitializeImpl()

bool Ipopt::Ma86SolverInterface::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::SparseSymLinearSolverInterface.

◆ InitializeStructure()

ESymSolverStatus Ipopt::Ma86SolverInterface::InitializeStructure	(	Index	dim,
		Index	nonzeros,
		const Index *	ia,
		const Index *	ja
	)

virtual

Method for initializing internal structures.

Here, ndim gives the number of rows and columns of the matrix, nonzeros give the number of nonzero elements, and ia and ja give the positions of the nonzero elements, given in the matrix format determined by MatrixFormat.

Implements Ipopt::SparseSymLinearSolverInterface.

◆ GetValuesArrayPtr()

Number * Ipopt::Ma86SolverInterface::GetValuesArrayPtr ( )

inlinevirtual

Method returning an internal array into which the nonzero elements (in the same order as ja) will be stored by the calling routine before a call to MultiSolve with a new_matrix=true (or after a return of MultiSolve with SYMSOLV_CALL_AGAIN).

The returned array must have space for at least nonzero elements.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 184 of file IpMa86SolverInterface.hpp.

◆ MultiSolve()

ESymSolverStatus Ipopt::Ma86SolverInterface::MultiSolve	(	bool	new_matrix,
		const Index *	ia,
		const Index *	ja,
		Index	nrhs,
		Number *	rhs_vals,
		bool	check_NegEVals,
		Index	numberOfNegEVals
	)

virtual

Solve operation for multiple right hand sides.

Solves the linear system A * x = b with multiple right hand sides, where A is the symmetric indefinite matrix. Here, ia and ja give the positions of the values (in the required matrix data format). The actual values of the matrix will have been given to this object by copying them into the array provided by GetValuesArrayPtr. ia and ja are identical to the ones given to InitializeStructure. The flag new_matrix is set to true, if the values of the matrix has changed, and a refactorization is required.

Returns: SYMSOLV_SUCCESS if the factorization and solves were successful, SYMSOLV_SINGULAR if the linear system is singular, and SYMSOLV_WRONG_INERTIA if check_NegEVals is true and the number of negative eigenvalues in the matrix does not match numberOfNegEVals. If SYMSOLV_CALL_AGAIN is returned, then the calling function will request the pointer for the array for storing a again (with GetValuesPtr), write the values of the nonzero elements into it, and call this MultiSolve method again with the same right-hand sides. (This can be done, for example, if the linear solver realized it does not have sufficient memory and needs to redo the factorization; e.g., for MA27.)

The number of right-hand sides is given by nrhs, the values of the right-hand sides are given in rhs_vals (one full right-hand side stored immediately after the other), and solutions are to be returned in the same array.

check_NegEVals will not be chosen true, if ProvidesInertia() returns false.

Implements Ipopt::SparseSymLinearSolverInterface.

◆ NumberOfNegEVals()

Index Ipopt::Ma86SolverInterface::NumberOfNegEVals ( ) const

inlinevirtual

Number of negative eigenvalues detected during last factorization.

Returns: the number of negative eigenvalues of the most recent factorized matrix.

This must not be called if the linear solver does not compute this quantities (see ProvidesInertia).

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 199 of file IpMa86SolverInterface.hpp.

◆ IncreaseQuality()

bool Ipopt::Ma86SolverInterface::IncreaseQuality ( )

virtual

Request to increase quality of solution for next solve.

The calling class asks linear solver to increase quality of solution for the next solve (e.g. increase pivot tolerance).

Returns: false, if this is not possible (e.g. maximal pivot tolerance already used.)

Implements Ipopt::SparseSymLinearSolverInterface.

◆ ProvidesInertia()

bool Ipopt::Ma86SolverInterface::ProvidesInertia ( ) const

inlinevirtual

Query whether inertia is computed by linear solver.

Returns: true, if linear solver provides inertia

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 209 of file IpMa86SolverInterface.hpp.

◆ MatrixFormat()

EMatrixFormat Ipopt::Ma86SolverInterface::MatrixFormat ( ) const

inlinevirtual

Query of requested matrix type that the linear solver understands.

Implements Ipopt::SparseSymLinearSolverInterface.

Definition at line 214 of file IpMa86SolverInterface.hpp.

◆ ProvidesDegeneracyDetection()

bool Ipopt::Ma86SolverInterface::ProvidesDegeneracyDetection ( ) const

inlinevirtual

Query whether the indices of linearly dependent rows/columns can be determined by this linear solver.

Reimplemented from Ipopt::SparseSymLinearSolverInterface.

Definition at line 223 of file IpMa86SolverInterface.hpp.

◆ DetermineDependentRows()

ESymSolverStatus Ipopt::Ma86SolverInterface::DetermineDependentRows	(	const Index *	,
		const Index *	,
		std::list< Index > &
	)

inlinevirtual

This method determines the list of row indices of the linearly dependent rows.

Reimplemented from Ipopt::SparseSymLinearSolverInterface.

Definition at line 228 of file IpMa86SolverInterface.hpp.

Member Data Documentation

◆ ndim_

int Ipopt::Ma86SolverInterface::ndim_

private

Number of dimensions.

Definition at line 105 of file IpMa86SolverInterface.hpp.

◆ val_

Number* Ipopt::Ma86SolverInterface::val_

private

Storage for variables.

Definition at line 106 of file IpMa86SolverInterface.hpp.

◆ numneg_

int Ipopt::Ma86SolverInterface::numneg_

private

Number of negative pivots in last factorization.

Definition at line 107 of file IpMa86SolverInterface.hpp.

◆ order_

int* Ipopt::Ma86SolverInterface::order_

private

Fill reducing permutation.

Definition at line 108 of file IpMa86SolverInterface.hpp.

◆ keep_

void* Ipopt::Ma86SolverInterface::keep_

private

Stores pointer to factors (only understood by Fortran code!)

Definition at line 109 of file IpMa86SolverInterface.hpp.

◆ pivtol_changed_

bool Ipopt::Ma86SolverInterface::pivtol_changed_

private

indicates if pivtol has been changed

Definition at line 110 of file IpMa86SolverInterface.hpp.

◆ control_

struct ma86_control Ipopt::Ma86SolverInterface::control_

private

Definition at line 113 of file IpMa86SolverInterface.hpp.

◆ umax_

Number Ipopt::Ma86SolverInterface::umax_

private

Definition at line 114 of file IpMa86SolverInterface.hpp.

◆ ordering_

int Ipopt::Ma86SolverInterface::ordering_

private

Definition at line 115 of file IpMa86SolverInterface.hpp.

◆ hslloader

SmartPtr<LibraryLoader> Ipopt::Ma86SolverInterface::hslloader

private

Definition at line 120 of file IpMa86SolverInterface.hpp.

◆ ma86_default_control

IPOPT_DECL_MA86_DEFAULT_CONTROL* Ipopt::Ma86SolverInterface::ma86_default_control

private

Definition at line 122 of file IpMa86SolverInterface.hpp.

◆ ma86_analyse

IPOPT_DECL_MA86_ANALYSE* Ipopt::Ma86SolverInterface::ma86_analyse

private

Definition at line 123 of file IpMa86SolverInterface.hpp.

◆ ma86_factor

IPOPT_DECL_MA86_FACTOR* Ipopt::Ma86SolverInterface::ma86_factor

private

Definition at line 124 of file IpMa86SolverInterface.hpp.

◆ ma86_factor_solve

IPOPT_DECL_MA86_FACTOR_SOLVE* Ipopt::Ma86SolverInterface::ma86_factor_solve

private

Definition at line 125 of file IpMa86SolverInterface.hpp.

◆ ma86_solve

IPOPT_DECL_MA86_SOLVE* Ipopt::Ma86SolverInterface::ma86_solve

private

Definition at line 126 of file IpMa86SolverInterface.hpp.

◆ ma86_finalise

IPOPT_DECL_MA86_FINALISE* Ipopt::Ma86SolverInterface::ma86_finalise

private

Definition at line 127 of file IpMa86SolverInterface.hpp.

◆ mc68_default_control

IPOPT_DECL_MC68_DEFAULT_CONTROL* Ipopt::Ma86SolverInterface::mc68_default_control

private

Definition at line 128 of file IpMa86SolverInterface.hpp.

◆ mc68_order

IPOPT_DECL_MC68_ORDER* Ipopt::Ma86SolverInterface::mc68_order

private

Definition at line 129 of file IpMa86SolverInterface.hpp.

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

src/Algorithm/LinearSolvers/IpMa86SolverInterface.hpp

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ order_opts

Constructor & Destructor Documentation

◆ Ma86SolverInterface()

◆ ~Ma86SolverInterface()

Member Function Documentation

◆ RegisterOptions()

◆ SetFunctions()

◆ InitializeImpl()

◆ InitializeStructure()

◆ GetValuesArrayPtr()

◆ MultiSolve()

◆ NumberOfNegEVals()

◆ IncreaseQuality()

◆ ProvidesInertia()

◆ MatrixFormat()

◆ ProvidesDegeneracyDetection()

◆ DetermineDependentRows()

Member Data Documentation

◆ ndim_

◆ val_

◆ numneg_

◆ order_

◆ keep_

◆ pivtol_changed_

◆ control_

◆ umax_

◆ ordering_

◆ hslloader

◆ ma86_default_control

◆ ma86_analyse

◆ ma86_factor

◆ ma86_factor_solve

◆ ma86_solve

◆ ma86_finalise

◆ mc68_default_control

◆ mc68_order