MatrixSpace base class, corresponding to the Matrix base class. More...
#include <IpMatrix.hpp>
Public Member Functions | |
virtual Matrix * | MakeNew () const =0 |
Pure virtual method for creating a new Matrix of the corresponding type. | |
Index | NRows () const |
Accessor function for the number of rows. | |
Index | NCols () const |
Accessor function for the number of columns. | |
bool | IsMatrixFromSpace (const Matrix &matrix) const |
Method to test if a given matrix belongs to a particular matrix space. | |
Constructors/Destructors | |
MatrixSpace (Index nRows, Index nCols) | |
Constructor, given the number rows and columns of all matrices generated by this MatrixSpace. | |
virtual | ~MatrixSpace () |
Destructor. | |
Private Member Functions | |
Default Compiler Generated Methods | |
MatrixSpace () | |
default constructor | |
MatrixSpace (const MatrixSpace &) | |
Copy constructor. | |
MatrixSpace & | operator= (const MatrixSpace &) |
Overloaded Equals Operator. | |
Private Attributes | |
const Index | nRows_ |
Number of rows for all matrices of this type. | |
const Index | nCols_ |
Number of columns for all matrices of this type. |
MatrixSpace base class, corresponding to the Matrix base class.
For each Matrix implementation, a corresponding MatrixSpace has to be implemented. A MatrixSpace is able to create new Matrices of a specific type. The MatrixSpace should also store information that is common to all Matrices of that type. For example, the dimensions of a Matrix is stored in the MatrixSpace base class.
Definition at line 205 of file IpMatrix.hpp.
Constructor, given the number rows and columns of all matrices generated by this MatrixSpace.
Definition at line 213 of file IpMatrix.hpp.
virtual Ipopt::MatrixSpace::~MatrixSpace | ( | ) | [inline, virtual] |
Destructor.
Definition at line 220 of file IpMatrix.hpp.
Ipopt::MatrixSpace::MatrixSpace | ( | ) | [private] |
default constructor
Ipopt::MatrixSpace::MatrixSpace | ( | const MatrixSpace & | ) | [private] |
Copy constructor.
virtual Matrix* Ipopt::MatrixSpace::MakeNew | ( | ) | const [pure virtual] |
Pure virtual method for creating a new Matrix of the corresponding type.
Implemented in Ipopt::CompoundMatrixSpace, Ipopt::DenseGenMatrixSpace, Ipopt::ExpansionMatrixSpace, Ipopt::MultiVectorMatrixSpace, Ipopt::ScaledMatrixSpace, Ipopt::SumMatrixSpace, Ipopt::SymMatrixSpace, Ipopt::SymScaledMatrixSpace, Ipopt::ZeroMatrixSpace, and Ipopt::GenTMatrixSpace.
Index Ipopt::MatrixSpace::NRows | ( | ) | const [inline] |
Accessor function for the number of rows.
Definition at line 230 of file IpMatrix.hpp.
Index Ipopt::MatrixSpace::NCols | ( | ) | const [inline] |
Accessor function for the number of columns.
Definition at line 235 of file IpMatrix.hpp.
bool Ipopt::MatrixSpace::IsMatrixFromSpace | ( | const Matrix & | matrix | ) | const [inline] |
Method to test if a given matrix belongs to a particular matrix space.
Definition at line 243 of file IpMatrix.hpp.
MatrixSpace& Ipopt::MatrixSpace::operator= | ( | const MatrixSpace & | ) | [private] |
Overloaded Equals Operator.
Reimplemented in Ipopt::CompoundMatrixSpace, Ipopt::CompoundSymMatrixSpace, Ipopt::DiagMatrixSpace, Ipopt::IdentityMatrixSpace, Ipopt::LowRankUpdateSymMatrixSpace, Ipopt::ScaledMatrixSpace, Ipopt::SumMatrixSpace, Ipopt::SymMatrixSpace, Ipopt::SymScaledMatrixSpace, and Ipopt::ZeroMatrixSpace.
const Index Ipopt::MatrixSpace::nRows_ [private] |
Number of rows for all matrices of this type.
Definition at line 268 of file IpMatrix.hpp.
const Index Ipopt::MatrixSpace::nCols_ [private] |
Number of columns for all matrices of this type.
Definition at line 270 of file IpMatrix.hpp.