Solver for the augmented system using GenKKTSolverInterfaces. More...

#include <IpGenAugSystemSolver.hpp>

Inheritance diagram for Ipopt::GenAugSystemSolver:

Public Member Functions
bool	InitializeImpl (const OptionsList &options, const std::string &prefix)
	overloaded from AlgorithmStrategyObject

virtual ESymSolverStatus	MultiSolve (const SymMatrix W, Number W_factor, const Vector D_x, Number delta_x, const Vector D_s, Number delta_s, const Matrix J_c, const Vector D_c, Number delta_c, const Matrix J_d, const Vector *D_d, Number delta_d, std::vector< SmartPtr< const Vector > > &rhs_xV, std::vector< SmartPtr< const Vector > > &rhs_sV, std::vector< SmartPtr< const Vector > > &rhs_cV, std::vector< SmartPtr< const Vector > > &rhs_dV, std::vector< SmartPtr< Vector > > &sol_xV, std::vector< SmartPtr< Vector > > &sol_sV, std::vector< SmartPtr< Vector > > &sol_cV, std::vector< SmartPtr< Vector > > &sol_dV, bool check_NegEVals, Index numberOfNegEVals)
	Set up the augmented system and solve it for a set of given right hand side - implementation for GenTMatrices and SymTMatrices.

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

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

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

Constructors/Destructors
	GenAugSystemSolver (GenKKTSolverInterface &SolverInterface)
	Constructor using only a linear solver object.

virtual	~GenAugSystemSolver ()
	Destructor.

Public Member Functions inherited from Ipopt::AugSystemSolver
virtual ESymSolverStatus	Solve (const SymMatrix W, Number W_factor, const Vector D_x, Number delta_x, const Vector D_s, Number delta_s, const Matrix J_c, const Vector D_c, Number delta_c, const Matrix J_d, const Vector *D_d, Number delta_d, const Vector &rhs_x, const Vector &rhs_s, const Vector &rhs_c, const Vector &rhs_d, Vector &sol_x, Vector &sol_s, Vector &sol_c, Vector &sol_d, bool check_NegEVals, Index numberOfNegEVals)
	Set up the augmented system and solve it for a given right hand side.

	AugSystemSolver ()
	Default constructor.

virtual	~AugSystemSolver ()
	Destructor.

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
bool	AugmentedSystemChanged (const SymMatrix W, Number W_factor, const Vector D_x, Number delta_x, const Vector D_s, Number delta_s, const Matrix &J_c, const Vector D_c, Number delta_c, const Matrix &J_d, const Vector *D_d, Number delta_d)
	Check the internal tags and decide if the passed variables are different from what is in the augmented_system_.

void	UpdateTags (const SymMatrix W, Number W_factor, const Vector D_x, Number delta_x, const Vector D_s, Number delta_s, const Matrix &J_c, const Vector D_c, Number delta_c, const Matrix &J_d, const Vector *D_d, Number delta_d)

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.
	GenAugSystemSolver ()
	Default constructor.

	GenAugSystemSolver (const GenAugSystemSolver &)
	Copy Constructor.

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

Private Attributes
SmartPtr< GenKKTSolverInterface >	solver_interface_
	The linear solver object that is to be used to solve the linear systems.

Tags and values to track in order to decide whether the
matrix has to be updated compared to the most recent call of the Set method.
TaggedObject::Tag	w_tag_
	Tag for W matrix.

Number	w_factor_
	Most recent value of W_factor.

TaggedObject::Tag	d_x_tag_
	Tag for D_x vector, representing the diagonal matrix D_x.

Number	delta_x_
	Most recent value of delta_x from Set method.

TaggedObject::Tag	d_s_tag_
	Tag for D_s vector, representing the diagonal matrix D_s.

Number	delta_s_
	Most recent value of delta_s from Set method.

TaggedObject::Tag	j_c_tag_
	Tag for J_c matrix.

TaggedObject::Tag	d_c_tag_
	Tag for D_c vector, representing the diagonal matrix D_c.

Number	delta_c_
	Most recent value of delta_c from Set method.

TaggedObject::Tag	j_d_tag_
	Tag for J_d matrix.

TaggedObject::Tag	d_d_tag_
	Tag for D_d vector, representing the diagonal matrix D_d.

Number	delta_d_
	Most recent value of delta_d from Set method.

Space for storing the diagonal matrices.
If the matrix hasn't changed, we can use it from the last call.
Number *	dx_vals_copy_

Number *	ds_vals_copy_

Number *	dc_vals_copy_

Number *	dd_vals_copy_

Algorithmic parameters
bool	warm_start_same_structure_
	Flag indicating whether the TNLP with identical structure has already been solved before.

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

Solver for the augmented system using GenKKTSolverInterfaces.

This takes any Vector values out and provides Number*'s, but Matrices are provided as given from the NLP.

Definition at line 21 of file IpGenAugSystemSolver.hpp.

Constructor & Destructor Documentation

◆ GenAugSystemSolver() [1/3]

Ipopt::GenAugSystemSolver::GenAugSystemSolver ( GenKKTSolverInterface & SolverInterface )

Constructor using only a linear solver object.

◆ ~GenAugSystemSolver()

virtual Ipopt::GenAugSystemSolver::~GenAugSystemSolver ( )

virtual

Destructor.

◆ GenAugSystemSolver() [2/3]

Ipopt::GenAugSystemSolver::GenAugSystemSolver ( )

private

Default constructor.

◆ GenAugSystemSolver() [3/3]

Ipopt::GenAugSystemSolver::GenAugSystemSolver ( const GenAugSystemSolver & )

private

Copy Constructor.

Member Function Documentation

◆ InitializeImpl()

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

virtual

overloaded from AlgorithmStrategyObject

Implements Ipopt::AugSystemSolver.

◆ MultiSolve()

virtual ESymSolverStatus Ipopt::GenAugSystemSolver::MultiSolve	(	const SymMatrix *	W,
		Number	W_factor,
		const Vector *	D_x,
		Number	delta_x,
		const Vector *	D_s,
		Number	delta_s,
		const Matrix *	J_c,
		const Vector *	D_c,
		Number	delta_c,
		const Matrix *	J_d,
		const Vector *	D_d,
		Number	delta_d,
		std::vector< SmartPtr< const Vector > > &	rhs_xV,
		std::vector< SmartPtr< const Vector > > &	rhs_sV,
		std::vector< SmartPtr< const Vector > > &	rhs_cV,
		std::vector< SmartPtr< const Vector > > &	rhs_dV,
		std::vector< SmartPtr< Vector > > &	sol_xV,
		std::vector< SmartPtr< Vector > > &	sol_sV,
		std::vector< SmartPtr< Vector > > &	sol_cV,
		std::vector< SmartPtr< Vector > > &	sol_dV,
		bool	check_NegEVals,
		Index	numberOfNegEVals
	)

virtual

Set up the augmented system and solve it for a set of given right hand side - implementation for GenTMatrices and SymTMatrices.

Reimplemented from Ipopt::AugSystemSolver.

◆ NumberOfNegEVals()

virtual Index Ipopt::GenAugSystemSolver::NumberOfNegEVals ( ) const

virtual

Number of negative eigenvalues detected during last solve.

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

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

Implements Ipopt::AugSystemSolver.

◆ ProvidesInertia()

virtual bool Ipopt::GenAugSystemSolver::ProvidesInertia ( ) const

virtual

Query whether inertia is computed by linear solver.

Returns: true, if linear solver provides inertia

Implements Ipopt::AugSystemSolver.

◆ IncreaseQuality()

virtual bool Ipopt::GenAugSystemSolver::IncreaseQuality ( )

virtual

Request to increase quality of solution for next solve.

Ask underlying 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::AugSystemSolver.

◆ operator=()

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

private

Default Assignment Operator.

◆ AugmentedSystemChanged()

bool Ipopt::GenAugSystemSolver::AugmentedSystemChanged	(	const SymMatrix *	W,
		Number	W_factor,
		const Vector *	D_x,
		Number	delta_x,
		const Vector *	D_s,
		Number	delta_s,
		const Matrix &	J_c,
		const Vector *	D_c,
		Number	delta_c,
		const Matrix &	J_d,
		const Vector *	D_d,
		Number	delta_d
	)

private

Check the internal tags and decide if the passed variables are different from what is in the augmented_system_.

◆ UpdateTags()

void Ipopt::GenAugSystemSolver::UpdateTags	(	const SymMatrix *	W,
		Number	W_factor,
		const Vector *	D_x,
		Number	delta_x,
		const Vector *	D_s,
		Number	delta_s,
		const Matrix &	J_c,
		const Vector *	D_c,
		Number	delta_c,
		const Matrix &	J_d,
		const Vector *	D_d,
		Number	delta_d
	)

private

Member Data Documentation

◆ solver_interface_

SmartPtr<GenKKTSolverInterface> Ipopt::GenAugSystemSolver::solver_interface_

private

The linear solver object that is to be used to solve the linear systems.

Definition at line 155 of file IpGenAugSystemSolver.hpp.

◆ w_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::w_tag_

private

Tag for W matrix.

If W has been given to Set as NULL, then this tag is set to 0

Definition at line 166 of file IpGenAugSystemSolver.hpp.

◆ w_factor_

Number Ipopt::GenAugSystemSolver::w_factor_

private

Most recent value of W_factor.

Definition at line 168 of file IpGenAugSystemSolver.hpp.

◆ d_x_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::d_x_tag_

private

Tag for D_x vector, representing the diagonal matrix D_x.

If D_x has been given to Set as NULL, then this tag is set to 0

Definition at line 173 of file IpGenAugSystemSolver.hpp.

◆ delta_x_

Number Ipopt::GenAugSystemSolver::delta_x_

private

Most recent value of delta_x from Set method.

Definition at line 175 of file IpGenAugSystemSolver.hpp.

◆ d_s_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::d_s_tag_

private

Tag for D_s vector, representing the diagonal matrix D_s.

If D_s has been given to Set as NULL, then this tag is set to 0

Definition at line 180 of file IpGenAugSystemSolver.hpp.

◆ delta_s_

Number Ipopt::GenAugSystemSolver::delta_s_

private

Most recent value of delta_s from Set method.

Definition at line 182 of file IpGenAugSystemSolver.hpp.

◆ j_c_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::j_c_tag_

private

Tag for J_c matrix.

If J_c has been given to Set as NULL, then this tag is set to 0

Definition at line 187 of file IpGenAugSystemSolver.hpp.

◆ d_c_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::d_c_tag_

private

Tag for D_c vector, representing the diagonal matrix D_c.

If D_c has been given to Set as NULL, then this tag is set to 0

Definition at line 192 of file IpGenAugSystemSolver.hpp.

◆ delta_c_

Number Ipopt::GenAugSystemSolver::delta_c_

private

Most recent value of delta_c from Set method.

Definition at line 194 of file IpGenAugSystemSolver.hpp.

◆ j_d_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::j_d_tag_

private

Tag for J_d matrix.

If J_d has been given to Set as NULL, then this tag is set to 0

Definition at line 199 of file IpGenAugSystemSolver.hpp.

◆ d_d_tag_

TaggedObject::Tag Ipopt::GenAugSystemSolver::d_d_tag_

private

Tag for D_d vector, representing the diagonal matrix D_d.

If D_d has been given to Set as NULL, then this tag is set to 0

Definition at line 204 of file IpGenAugSystemSolver.hpp.

◆ delta_d_

Number Ipopt::GenAugSystemSolver::delta_d_

private

Most recent value of delta_d from Set method.

Definition at line 206 of file IpGenAugSystemSolver.hpp.

◆ dx_vals_copy_

Number* Ipopt::GenAugSystemSolver::dx_vals_copy_

private

Definition at line 214 of file IpGenAugSystemSolver.hpp.

◆ ds_vals_copy_

Number* Ipopt::GenAugSystemSolver::ds_vals_copy_

private

Definition at line 215 of file IpGenAugSystemSolver.hpp.

◆ dc_vals_copy_

Number* Ipopt::GenAugSystemSolver::dc_vals_copy_

private

Definition at line 216 of file IpGenAugSystemSolver.hpp.

◆ dd_vals_copy_

Number* Ipopt::GenAugSystemSolver::dd_vals_copy_

private

Definition at line 217 of file IpGenAugSystemSolver.hpp.

◆ warm_start_same_structure_

bool Ipopt::GenAugSystemSolver::warm_start_same_structure_

private

Flag indicating whether the TNLP with identical structure has already been solved before.

Definition at line 225 of file IpGenAugSystemSolver.hpp.

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

src/Algorithm/IpGenAugSystemSolver.hpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenAugSystemSolver() [1/3]

◆ ~GenAugSystemSolver()

◆ GenAugSystemSolver() [2/3]

◆ GenAugSystemSolver() [3/3]

Member Function Documentation

◆ InitializeImpl()

◆ MultiSolve()

◆ NumberOfNegEVals()

◆ ProvidesInertia()

◆ IncreaseQuality()

◆ operator=()

◆ AugmentedSystemChanged()

◆ UpdateTags()

Member Data Documentation

◆ solver_interface_

◆ w_tag_

◆ w_factor_

◆ d_x_tag_

◆ delta_x_

◆ d_s_tag_

◆ delta_s_

◆ j_c_tag_

◆ d_c_tag_

◆ delta_c_

◆ j_d_tag_

◆ d_d_tag_

◆ delta_d_

◆ dx_vals_copy_

◆ ds_vals_copy_

◆ dc_vals_copy_

◆ dd_vals_copy_

◆ warm_start_same_structure_