Class for Matrices which are sum of matrices. More...
#include <IpSumMatrix.hpp>
Public Member Functions | |
void | SetTerm (Index iterm, Number factor, const Matrix &matrix) |
Method for setting term iterm for the sum. | |
void | GetTerm (Index iterm, Number &factor, SmartPtr< const Matrix > &matrix) const |
Method for getting term iterm for the sum. | |
Index | NTerms () const |
Return the number of terms. | |
Constructors / Destructors | |
SumMatrix (const SumMatrixSpace *owner_space) | |
Constructor, taking the owner_space. | |
virtual | ~SumMatrix () |
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 + alpha*Z*M^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 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. | |
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 + alpha*Z*M^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 | |
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. | |
SumMatrix () | |
Default Constructor. | |
SumMatrix (const SumMatrix &) | |
Copy Constructor. | |
void | operator= (const SumMatrix &) |
Default Assignment Operator. | |
Private Attributes | |
std::vector< Number > | factors_ |
std::vector storing the factors for each term. | |
std::vector< SmartPtr< const Matrix > > | matrices_ |
std::vector storing the matrices for each term. | |
const SumMatrixSpace * | owner_space_ |
Copy of the owner_space as a SumMatrixSpace. | |
Additional Inherited Members | |
Public Types inherited from Ipopt::TaggedObject | |
typedef unsigned int | Tag |
Type for the Tag values. | |
Class for Matrices which are sum of matrices.
For each term in the sum we store the matrix and a factor.
Definition at line 23 of file IpSumMatrix.hpp.
Ipopt::SumMatrix::SumMatrix | ( | const SumMatrixSpace * | owner_space | ) |
Constructor, taking the owner_space.
|
virtual |
Destructor.
|
private |
Default Constructor.
Method for setting term iterm for the sum.
void Ipopt::SumMatrix::GetTerm | ( | Index | iterm, |
Number & | factor, | ||
SmartPtr< const Matrix > & | matrix | ||
) | const |
Method for getting term iterm for the sum.
Note that counting of terms starts at 0.
Index Ipopt::SumMatrix::NTerms | ( | ) | const |
Return the number of terms.
|
protectedvirtual |
Matrix(transpose) vector multiply.
Computes y = alpha * Matrix^T * x + beta * y.
Implements Ipopt::Matrix.
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.
|
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.
|
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.
|
protectedvirtual |
Print detailed information about the matrix.
Implements Ipopt::Matrix.
|
private |
std::vector storing the factors for each term.
Definition at line 121 of file IpSumMatrix.hpp.
std::vector storing the matrices for each term.
Definition at line 124 of file IpSumMatrix.hpp.
|
private |
Copy of the owner_space as a SumMatrixSpace.
Definition at line 127 of file IpSumMatrix.hpp.