Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Ipopt::CompoundMatrix Class Reference

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. More...
 
void SetCompNonConst (Index irow, Index jcol, Matrix &matrix)
 Method to set a non-const Matrix entry. More...
 
void CreateBlockFromSpace (Index irow, Index jcol)
 Method to create a new matrix from the space for this block. More...
 
SmartPtr< const MatrixGetComp (Index irow, Index jcol) const
 Method for retrieving one block from the compound matrix as a const Matrix. More...
 
SmartPtr< MatrixGetCompNonConst (Index irow, Index jcol)
 Method for retrieving one block from the compound matrix as a non-const Matrix. More...
 
Index NComps_Rows () const
 Number of block rows of this compound matrix. More...
 
Index NComps_Cols () const
 Number of block colmuns of this compound matrix. More...
 
Constructors / Destructors
 CompoundMatrix (const CompoundMatrixSpace *owner_space)
 Constructor, taking the owner_space. More...
 
virtual ~CompoundMatrix ()
 Destructor. More...
 
- 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). More...
 
SmartPtr< const MatrixSpaceOwnerSpace () const
 Return the owner MatrixSpace. More...
 
 Matrix (const MatrixSpace *owner_space)
 Constructor. More...
 
virtual ~Matrix ()
 Destructor. More...
 
void MultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix-vector multiply. More...
 
void TransMultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix(transpose) vector multiply. More...
 
void AddMSinvZ (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = X + alpha*(Matrix S^{-1} Z). More...
 
void SinvBlrmZMTdBr (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
 X = S^{-1} (r + alpha*Z*M^Td). More...
 
Index NRows () const
 Number of rows. More...
 
Index NCols () const
 Number of columns. More...
 
void ComputeRowAMax (Vector &rows_norms, bool init=true) const
 Compute the max-norm of the rows in the matrix. More...
 
void ComputeColAMax (Vector &cols_norms, bool init=true) const
 Compute the max-norm of the columns in the matrix. More...
 
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. More...
 
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. More...
 
virtual ~TaggedObject ()
 Destructor. More...
 
Tag GetTag () const
 Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation. More...
 
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. More...
 
- 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. More...
 
virtual ~Subject ()
 Default destructor. More...
 
void AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
 Attach the specified observer (i.e., begin recieving notifications). More...
 
void DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
 Detach the specified observer (i.e., no longer recieve notifications). More...
 

Protected Member Functions

Methods overloaded from Matrix
virtual void MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix-vector multiply. More...
 
virtual void TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix(transpose) vector multiply. More...
 
virtual void AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = beta*X + alpha*(Matrix S^{-1} Z). More...
 
virtual void SinvBlrmZMTdBrImpl (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
 X = S^{-1} (r + alpha*Z*M^Td). More...
 
virtual bool HasValidNumbersImpl () const
 Method for determining if all stored numbers are valid (i.e., no Inf or Nan). More...
 
virtual void ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
 Compute the max-norm of the rows in the matrix. More...
 
virtual void ComputeColAMaxImpl (Vector &cols_norms, bool init) const
 Compute the max-norm of the columns in the matrix. More...
 
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. More...
 
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. More...
 
- 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. More...
 
const MatrixConstComp (Index irow, Index jcol) const
 
MatrixComp (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. More...
 
 CompoundMatrix (const CompoundMatrix &)
 Copy Constructor. More...
 
void operator= (const CompoundMatrix &)
 Overloaded Equals Operator. More...
 

Private Attributes

std::vector< std::vector
< SmartPtr< Matrix > > > 
comps_
 Matrix of matrix's containing the components. More...
 
std::vector< std::vector
< SmartPtr< const Matrix > > > 
const_comps_
 Matrix of const matrix's containing the components. More...
 
const CompoundMatrixSpaceowner_space_
 Copy of the owner_space ptr as a CompoundMatrixSpace instead of MatrixSpace. More...
 
bool matrices_valid_
 boolean indicating if the compound matrix is in a "valid" state More...
 

Additional Inherited Members

- Public Types inherited from Ipopt::TaggedObject
typedef unsigned int Tag
 Type for the Tag values. More...
 

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.

virtual Ipopt::CompoundMatrix::~CompoundMatrix ( )
virtual

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

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

Number of block colmuns of this compound matrix.

Definition at line 311 of file IpCompoundMatrix.hpp.

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.

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.

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

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
protectedvirtual

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

Specialized implementation.

Reimplemented from Ipopt::Matrix.

virtual bool Ipopt::CompoundMatrix::HasValidNumbersImpl ( ) const
protectedvirtual

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

Reimplemented from Ipopt::Matrix.

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.

Implements Ipopt::Matrix.

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.

Implements 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
protectedvirtual

Print detailed information about the matrix.

Implements Ipopt::Matrix.

void Ipopt::CompoundMatrix::operator= ( const CompoundMatrix )
private

Overloaded Equals Operator.

bool Ipopt::CompoundMatrix::MatricesValid ( ) const
private

Method to check whether or not the matrices are valid.

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

Definition at line 317 of file IpCompoundMatrix.hpp.

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

Definition at line 332 of file IpCompoundMatrix.hpp.

Member Data Documentation

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

Matrix of matrix's containing the components.

Definition at line 143 of file IpCompoundMatrix.hpp.

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

Matrix of const matrix's containing the components.

Definition at line 146 of file IpCompoundMatrix.hpp.

const CompoundMatrixSpace* Ipopt::CompoundMatrix::owner_space_
private

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

Definition at line 150 of file IpCompoundMatrix.hpp.

bool Ipopt::CompoundMatrix::matrices_valid_
mutableprivate

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

Definition at line 153 of file IpCompoundMatrix.hpp.


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