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

#include <IpCompoundMatrix.hpp>

Inheritance diagram for Ipopt::CompoundMatrix:

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.

virtual	~CompoundMatrix ()
	Destructor.

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 void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix(transpose) vector multiply.

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).

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	ComputeColAMaxImpl (Vector &cols_norms, bool init) const
	Compute the max-norm of the columns 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.

implementation methods (derived classes MUST
overload these pure virtual protected methods).
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 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 &)
	Default Assignment 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

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

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

◆ CompoundMatrix() [1/3]

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.

◆ ~CompoundMatrix()

virtual Ipopt::CompoundMatrix::~CompoundMatrix ( )

virtual

Destructor.

◆ CompoundMatrix() [2/3]

Ipopt::CompoundMatrix::CompoundMatrix ( )

private

Default Constructor.

◆ CompoundMatrix() [3/3]

Ipopt::CompoundMatrix::CompoundMatrix ( const CompoundMatrix & )

private

Copy Constructor.

Member Function Documentation

◆ SetComp()

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.

◆ SetCompNonConst()

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

Method to set a non-const Matrix entry.

◆ CreateBlockFromSpace()

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

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

◆ GetComp()

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 83 of file IpCompoundMatrix.hpp.

◆ GetCompNonConst()

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 98 of file IpCompoundMatrix.hpp.

◆ NComps_Rows()

Index Ipopt::CompoundMatrix::NComps_Rows ( ) const

inline

Number of block rows of this compound matrix.

Definition at line 383 of file IpCompoundMatrix.hpp.

◆ NComps_Cols()

Index Ipopt::CompoundMatrix::NComps_Cols ( ) const

inline

Number of block colmuns of this compound matrix.

Definition at line 388 of file IpCompoundMatrix.hpp.

◆ MultVectorImpl()

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

◆ TransMultVectorImpl()

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

protectedvirtual

Matrix(transpose) vector multiply.

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

Implements Ipopt::Matrix.

◆ AddMSinvZImpl()

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

protectedvirtual

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

Prototype for this specialize method is provided, but for efficient implementation it should be overloaded for the expansion matrix.

Reimplemented from Ipopt::Matrix.

◆ SinvBlrmZMTdBrImpl()

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

protectedvirtual

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

Should be implemented efficiently for the ExpansionMatrix.

Reimplemented from Ipopt::Matrix.

◆ HasValidNumbersImpl()

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

◆ ComputeColAMaxImpl()

virtual void Ipopt::CompoundMatrix::ComputeColAMaxImpl	(	Vector &	cols_norms,
		bool	init
	)		const

protectedvirtual

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

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

Implements Ipopt::Matrix.

◆ PrintImpl()

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

private

Default Assignment Operator.

◆ MatricesValid()

bool Ipopt::CompoundMatrix::MatricesValid ( ) const

private

Method to check whether or not the matrices are valid.

◆ ConstComp()

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

inlineprivate

Definition at line 393 of file IpCompoundMatrix.hpp.

◆ Comp()

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

inlineprivate

Definition at line 412 of file IpCompoundMatrix.hpp.

Member Data Documentation

◆ comps_

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

private

Matrix of matrix's containing the components.

Definition at line 190 of file IpCompoundMatrix.hpp.

◆ const_comps_

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

private

Matrix of const matrix's containing the components.

Definition at line 193 of file IpCompoundMatrix.hpp.

◆ owner_space_

const CompoundMatrixSpace* Ipopt::CompoundMatrix::owner_space_

private

Copy of the owner_space ptr as a CompoundMatrixSpace instead of MatrixSpace.

Definition at line 198 of file IpCompoundMatrix.hpp.

◆ matrices_valid_

bool Ipopt::CompoundMatrix::matrices_valid_

mutableprivate

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

Definition at line 201 of file IpCompoundMatrix.hpp.

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

src/LinAlg/IpCompoundMatrix.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CompoundMatrix() [1/3]

◆ ~CompoundMatrix()

◆ CompoundMatrix() [2/3]

◆ CompoundMatrix() [3/3]

Member Function Documentation

◆ SetComp()

◆ SetCompNonConst()

◆ CreateBlockFromSpace()

◆ GetComp()

◆ GetCompNonConst()

◆ NComps_Rows()

◆ NComps_Cols()

◆ MultVectorImpl()

◆ TransMultVectorImpl()

◆ AddMSinvZImpl()

◆ SinvBlrmZMTdBrImpl()

◆ HasValidNumbersImpl()

◆ ComputeRowAMaxImpl()

◆ ComputeColAMaxImpl()

◆ PrintImpl()

◆ operator=()

◆ MatricesValid()

◆ ConstComp()

◆ Comp()

Member Data Documentation

◆ comps_

◆ const_comps_

◆ owner_space_

◆ matrices_valid_