Ipopt::CompoundMatrix Class Reference

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

#include <IpCompoundMatrix.hpp>

Inheritance diagram for Ipopt::CompoundMatrix:

[legend]

Collaboration diagram for Ipopt::CompoundMatrix:

[legend]

List of all members.

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)
	Method to set a non-const Matrix entry.
void	CreateBlockFromSpace (Index irow, Index jcol)
	Method to create a new matrix from the space for this block.
SmartPtr< const Matrix >	GetComp (Index irow, Index jcol) const
	Method for retrieving one block from the compound matrix as a const Matrix.
SmartPtr< Matrix >	GetCompNonConst (Index irow, Index jcol)
	Method for retrieving one block from the compound matrix as a non-const Matrix.
Index	NComps_Rows () const
	Number of block rows of this compound matrix.
Index	NComps_Cols () const
	Number of block colmuns of this compound matrix.
Constructors / Destructors

	CompoundMatrix (const CompoundMatrixSpace *owner_space)
	Constructor, taking the owner_space.
	~CompoundMatrix ()
	Destructor.
Protected Member Functions
Methods overloaded from Matrix

virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	X = betaX + alpha(Matrix S^{-1} Z).
virtual void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	X = betaX + alpha(Matrix S^{-1} Z).
virtual void	AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = betaX + 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).
virtual bool	HasValidNumbersImpl () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
virtual void	PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
	X = betaX + alpha(Matrix S^{-1} Z).
Private Member Functions
bool	MatricesValid () const
	Method to check whether or not the matrices are valid.
const Matrix *	ConstComp (Index irow, Index jcol) const
Matrix *	Comp (Index irow, Index jcol)
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.
	CompoundMatrix ()
	Default Constructor.
	CompoundMatrix (const CompoundMatrix &)
	Copy Constructor.
void	operator= (const CompoundMatrix &)
	Overloaded Equals Operator.
Private Attributes
std::vector< std::vector < SmartPtr< Matrix > > >	comps_
	Matrix of matrix's containing the components.
std::vector< std::vector < SmartPtr< const Matrix > > >	const_comps_
	Matrix of const matrix's containing the components.
const CompoundMatrixSpace *	owner_space_
	Copy of the owner_space ptr as a CompoundMatrixSpace instead of MatrixSpace.
bool	matrices_valid_
	boolean indicating if the compound matrix is in a "valid" state

Detailed Description

Class for Matrices consisting of other matrices.

This matrix is a matrix that consists of zero, one or more Matrices's which are arranged like this: $M_{\rm compound} = \left(\begin{array}{cccc}M_{00} & M_{01} & \ldots & M_{0,{\rm ncomp\_cols}-1} \\ \dots &&&\dots \\ M_{{\rm ncomp\_rows}-1,0} & M_{{\rm ncomp\_rows}-1,1} & \dots & M_{{\rm ncomp\_rows}-1,{\rm ncomp\_cols}-1}\end{array}\right)$ . The individual components can be associated to different MatrixSpaces. The individual components can also be const and non-const Matrices. If a component is not set (i.e., it's pointer is NULL), then this components is treated like a zero-matrix of appropriate dimensions.

Definition at line 34 of file IpCompoundMatrix.hpp.

Constructor & Destructor Documentation

Ipopt::CompoundMatrix::CompoundMatrix ( const CompoundMatrixSpace * owner_space )

Constructor, taking the owner_space.

The owner_space has to be defined, so that at each block row and column contain at least one non-NULL component. The individual components can be set afterwards with the SeteComp and SetCompNonConst methods.

Ipopt::CompoundMatrix::~CompoundMatrix ( )

Destructor.

Ipopt::CompoundMatrix::CompoundMatrix ( ) [private]

Default Constructor.

Ipopt::CompoundMatrix::CompoundMatrix ( const CompoundMatrix & ) [private]

Copy Constructor.

Member Function Documentation

void Ipopt::CompoundMatrix::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.

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

Method to set a non-const Matrix entry.

void Ipopt::CompoundMatrix::CreateBlockFromSpace	(	Index	irow,
		Index	jcol
	)

Method to create a new matrix from the space for this block.

SmartPtr<const Matrix> Ipopt::CompoundMatrix::GetComp	(	Index	irow,
		Index	jcol
	)			const `[inline]`

Method for retrieving one block from the compound matrix as a const Matrix.

Definition at line 67 of file IpCompoundMatrix.hpp.

SmartPtr<Matrix> Ipopt::CompoundMatrix::GetCompNonConst	(	Index	irow,
		Index	jcol
	)			`[inline]`

Method for retrieving one block from the compound matrix as a non-const Matrix.

Note that calling this method with mark the CompoundMatrix as changed. Therefore, only use this method if you are intending to change the Matrix that you receive.

Definition at line 76 of file IpCompoundMatrix.hpp.

Index Ipopt::CompoundMatrix::NComps_Rows ( ) const [inline]

Number of block rows of this compound matrix.

Definition at line 301 of file IpCompoundMatrix.hpp.

Index Ipopt::CompoundMatrix::NComps_Cols ( ) const [inline]

Number of block colmuns of this compound matrix.

Definition at line 307 of file IpCompoundMatrix.hpp.

virtual void Ipopt::CompoundMatrix::MultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)			const `[protected, virtual]`

X = beta*X + alpha*(Matrix S^{-1} Z).

Specialized implementation.

Implements Ipopt::Matrix.

virtual void Ipopt::CompoundMatrix::TransMultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)			const `[protected, virtual]`

X = beta*X + alpha*(Matrix S^{-1} Z).

Specialized implementation.

Implements Ipopt::Matrix.

virtual void Ipopt::CompoundMatrix::AddMSinvZImpl	(	Number	alpha,
		const Vector &	S,
		const Vector &	Z,
		Vector &	X
	)			const `[protected, virtual]`

X = beta*X + alpha*(Matrix S^{-1} Z).

Specialized implementation.

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::CompoundMatrix::SinvBlrmZMTdBrImpl	(	Number	alpha,
		const Vector &	S,
		const Vector &	R,
		const Vector &	Z,
		const Vector &	D,
		Vector &	X
	)			const `[protected, virtual]`

X = S^{-1} (r + alpha*Z*M^Td).

Specialized implementation.

Reimplemented from Ipopt::Matrix.

virtual bool Ipopt::CompoundMatrix::HasValidNumbersImpl ( ) const [protected, virtual]

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

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::CompoundMatrix::PrintImpl	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent,
		const std::string &	prefix
	)			const `[protected, virtual]`