Class for symmetric matrices consisting of other matrices. More...

#include <IpCompoundSymMatrix.hpp>

Inheritance diagram for Ipopt::CompoundSymMatrix:

Public Member Functions
void	SetComp (Index irow, Index jcol, const Matrix &matrix)
	Method for setting an individual component at position (irow, icol) in the compound matrix.

void	SetCompNonConst (Index irow, Index jcol, Matrix &matrix)
	Non const version of the same method.

SmartPtr< const Matrix >	GetComp (Index irow, Index jcol) const
	Method for retrieving one block from the compound matrix.

SmartPtr< Matrix >	GetCompNonConst (Index irow, Index jcol)
	Non const version of GetComp.

SmartPtr< CompoundSymMatrix >	MakeNewCompoundSymMatrix () const
	Method for creating a new matrix of this specific type.

Index	NComps_Dim () const
	Number of block rows and columns.

Constructors / Destructors
	CompoundSymMatrix (const CompoundSymMatrixSpace *owner_space)
	Constructor, taking only the number for block components into the row and column direction.

	~CompoundSymMatrix ()
	Destructor.

Public Member Functions inherited from Ipopt::SymMatrix
SmartPtr< const SymMatrixSpace >	OwnerSymMatrixSpace () const

	SymMatrix (const SymMatrixSpace *owner_space)
	Constructor, taking the owner_space.

virtual	~SymMatrix ()
	Destructor.

Index	Dim () const
	Dimension of the matrix (number of rows and columns)

Public Member Functions inherited from Ipopt::Matrix
bool	HasValidNumbers () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

SmartPtr< const MatrixSpace >	OwnerSpace () const
	Return the owner MatrixSpace.

	Matrix (const MatrixSpace *owner_space)
	Constructor.

virtual	~Matrix ()
	Destructor.

void	MultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix-vector multiply.

void	TransMultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix(transpose) vector multiply.

void	AddMSinvZ (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = X + alpha*(Matrix S^{-1} Z).

void	SinvBlrmZMTdBr (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
	X = S^{-1} (r + alphaZM^Td).

Index	NRows () const
	Number of rows.

Index	NCols () const
	Number of columns.

void	ComputeRowAMax (Vector &rows_norms, bool init=true) const
	Compute the max-norm of the rows in the matrix.

void	ComputeColAMax (Vector &cols_norms, bool init=true) const
	Compute the max-norm of the columns in the matrix.

virtual void	Print (SmartPtr< const Journalist > jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const
	Print detailed information about the matrix.

virtual void	Print (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const

Public Member Functions inherited from Ipopt::TaggedObject
	TaggedObject ()
	Constructor.

virtual	~TaggedObject ()
	Destructor.

Tag	GetTag () const
	Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation.

bool	HasChanged (const Tag comparison_tag) const
	Users of TaggedObjects call this to check if the object HasChanged since they last updated their own internal tag.

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

Public Member Functions inherited from Ipopt::Subject
	Subject ()
	Default Constructor.

virtual	~Subject ()
	Destructor.

void	AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Attach the specified observer (i.e., begin receiving notifications).

void	DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Detach the specified observer (i.e., no longer receive notifications).

Protected Member Functions
Methods overloaded from matrix
virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix-vector multiply.

virtual bool	HasValidNumbersImpl () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

virtual void	ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
	Compute the max-norm of the rows in the matrix.

virtual void	PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
	Print detailed information about the matrix.

Protected Member Functions inherited from Ipopt::SymMatrix
virtual void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Implementation of TransMultVectorImpl, which calls MultVectorImpl.

virtual void	ComputeColAMaxImpl (Vector &cols_norms, bool init) const
	Implementation of ComputeColAMaxImpl, which calls ComputeRowAMaxImpl.

Protected Member Functions inherited from Ipopt::Matrix
virtual void	AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = X + alpha*(Matrix S^{-1} Z).

virtual void	SinvBlrmZMTdBrImpl (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
	X = S^{-1} (r + alphaZM^Td).

Protected Member Functions inherited from Ipopt::TaggedObject
void	ObjectChanged ()
	Objects derived from TaggedObject MUST call this method every time their internal state changes to update the internal tag for comparison.

Protected Member Functions inherited from Ipopt::Subject
void	Notify (Observer::NotifyType notify_type) const

Private Member Functions
bool	MatricesValid () const
	method to check wether or not the matrices are valid

const Matrix *	ConstComp (Index irow, Index jcol) const
	Internal method to return a const pointer to one of the comps.

Matrix *	Comp (Index irow, Index jcol)
	Internal method to return a non-const pointer to one of the comps.

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.
	CompoundSymMatrix ()
	Default Constructor.

	CompoundSymMatrix (const CompoundSymMatrix &)
	Copy Constructor.

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

Private Attributes
std::vector< std::vector< SmartPtr< Matrix > > >	comps_
	Vector of vectors containing the components.

std::vector< std::vector< SmartPtr< const Matrix > > >	const_comps_
	Vector of vectors containing the const components.

const CompoundSymMatrixSpace *	owner_space_
	Copy of the owner_space ptr as a CompoundSymMatrixSpace.

bool	matrices_valid_
	boolean indicating if the compound matrix is in a "valid" state

Additional Inherited Members
Public Types inherited from Ipopt::TaggedObject
typedef unsigned int	Tag
	Type for the Tag values.

Detailed Description

Class for symmetric matrices consisting of other matrices.

Here, the lower left block of the matrix is stored.

Definition at line 23 of file IpCompoundSymMatrix.hpp.

Constructor & Destructor Documentation

◆ CompoundSymMatrix() [1/3]

Ipopt::CompoundSymMatrix::CompoundSymMatrix ( const CompoundSymMatrixSpace * owner_space )

Constructor, taking only the number for block components into the row and column direction.

The owner_space has to be defined, so that at each block row and column contain at least one non-NULL component.

◆ ~CompoundSymMatrix()

Ipopt::CompoundSymMatrix::~CompoundSymMatrix ( )

Destructor.

◆ CompoundSymMatrix() [2/3]

Ipopt::CompoundSymMatrix::CompoundSymMatrix ( )

private

Default Constructor.

◆ CompoundSymMatrix() [3/3]

Ipopt::CompoundSymMatrix::CompoundSymMatrix ( const CompoundSymMatrix & )

private

Copy Constructor.

Member Function Documentation

◆ SetComp()

void Ipopt::CompoundSymMatrix::SetComp	(	Index	irow,
		Index	jcol,
		const Matrix &	matrix
	)

Method for setting an individual component at position (irow, icol) in the compound matrix.

The counting of indices starts at 0. Since this only the lower left components are stored, we need to have jcol<=irow, and if irow==jcol, the matrix must be a SymMatrix.

◆ SetCompNonConst()

void Ipopt::CompoundSymMatrix::SetCompNonConst	(	Index	irow,
		Index	jcol,
		Matrix &	matrix
	)

Non const version of the same method.

◆ GetComp()

SmartPtr< const Matrix > Ipopt::CompoundSymMatrix::GetComp	(	Index	irow,
		Index	jcol
	)		const

inline

Method for retrieving one block from the compound matrix.

Since this only the lower left components are stored, we need to have jcol<=irow.

Definition at line 68 of file IpCompoundSymMatrix.hpp.

◆ GetCompNonConst()

SmartPtr< Matrix > Ipopt::CompoundSymMatrix::GetCompNonConst	(	Index	irow,
		Index	jcol
	)

inline

Non const version of GetComp.

You should only use this method if you are intending to change the matrix you receive, since this CompoundSymMatrix will be marked as changed.

Definition at line 82 of file IpCompoundSymMatrix.hpp.

◆ MakeNewCompoundSymMatrix()

SmartPtr< CompoundSymMatrix > Ipopt::CompoundSymMatrix::MakeNewCompoundSymMatrix ( ) const

inline

Method for creating a new matrix of this specific type.

Definition at line 342 of file IpCompoundSymMatrix.hpp.

◆ NComps_Dim()

Index Ipopt::CompoundSymMatrix::NComps_Dim ( ) const

Number of block rows and columns.

◆ MultVectorImpl()

virtual void Ipopt::CompoundSymMatrix::MultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)		const

protectedvirtual

Matrix-vector multiply.

Computes y = alpha * Matrix * x + beta * y.

Implements Ipopt::Matrix.

◆ HasValidNumbersImpl()

virtual bool Ipopt::CompoundSymMatrix::HasValidNumbersImpl ( ) const

protectedvirtual

Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

A default implementation always returning true is provided, but if possible it should be implemented.

Reimplemented from Ipopt::Matrix.

◆ ComputeRowAMaxImpl()

virtual void Ipopt::CompoundSymMatrix::ComputeRowAMaxImpl	(	Vector &	rows_norms,
		bool	init
	)		const

protectedvirtual

Compute the max-norm of the rows in the matrix.

The result is stored in rows_norms. The vector is assumed to be initialized if init is false.

Implements Ipopt::Matrix.

◆ PrintImpl()

virtual void Ipopt::CompoundSymMatrix::PrintImpl	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent,
		const std::string &	prefix
	)		const

protectedvirtual

Print detailed information about the matrix.

Implements Ipopt::Matrix.

◆ operator=()

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

private

Default Assignment Operator.

◆ MatricesValid()

bool Ipopt::CompoundSymMatrix::MatricesValid ( ) const

private

method to check wether or not the matrices are valid

◆ ConstComp()

const Matrix * Ipopt::CompoundSymMatrix::ConstComp	(	Index	irow,
		Index	jcol
	)		const

inlineprivate

Internal method to return a const pointer to one of the comps.

Definition at line 169 of file IpCompoundSymMatrix.hpp.

◆ Comp()

Matrix * Ipopt::CompoundSymMatrix::Comp	(	Index	irow,
		Index	jcol
	)

inlineprivate

Internal method to return a non-const pointer to one of the comps.

Definition at line 189 of file IpCompoundSymMatrix.hpp.

Member Data Documentation

◆ comps_

std::vector<std::vector<SmartPtr<Matrix> > > Ipopt::CompoundSymMatrix::comps_

private

Vector of vectors containing the components.

Definition at line 154 of file IpCompoundSymMatrix.hpp.

◆ const_comps_

std::vector<std::vector<SmartPtr<const Matrix> > > Ipopt::CompoundSymMatrix::const_comps_

private

Vector of vectors containing the const components.

Definition at line 157 of file IpCompoundSymMatrix.hpp.

◆ owner_space_

const CompoundSymMatrixSpace* Ipopt::CompoundSymMatrix::owner_space_

private

Copy of the owner_space ptr as a CompoundSymMatrixSpace.

Definition at line 160 of file IpCompoundSymMatrix.hpp.

◆ matrices_valid_

bool Ipopt::CompoundSymMatrix::matrices_valid_

mutableprivate

boolean indicating if the compound matrix is in a "valid" state

Definition at line 163 of file IpCompoundSymMatrix.hpp.

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

src/LinAlg/IpCompoundSymMatrix.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CompoundSymMatrix() [1/3]

◆ ~CompoundSymMatrix()

◆ CompoundSymMatrix() [2/3]

◆ CompoundSymMatrix() [3/3]

Member Function Documentation

◆ SetComp()

◆ SetCompNonConst()

◆ GetComp()

◆ GetCompNonConst()

◆ MakeNewCompoundSymMatrix()

◆ NComps_Dim()

◆ MultVectorImpl()

◆ HasValidNumbersImpl()

◆ ComputeRowAMaxImpl()

◆ PrintImpl()

◆ operator=()

◆ MatricesValid()

◆ ConstComp()

◆ Comp()

Member Data Documentation

◆ comps_

◆ const_comps_

◆ owner_space_

◆ matrices_valid_