Class for matrix space for SumSymMatrix. More...
#include <IpSumSymMatrix.hpp>
Inheritance diagram for Ipopt::SumSymMatrixSpace:
Public Member Functions | |
Constructors / Destructors | |
| SumSymMatrixSpace (Index ndim, Index nterms) | |
| Constructor, given the dimension of the matrix and the number of terms in the sum. | |
| ~SumSymMatrixSpace () | |
| Destructor. | |
| Public Member Functions inherited from Ipopt::SymMatrixSpace | |
| SymMatrixSpace (Index dim) | |
| Constructor, given the dimension (identical to the number of rows and columns). | |
| virtual | ~SymMatrixSpace () |
| Destructor. | |
| virtual Matrix * | MakeNew () const |
| Overloaded MakeNew method for the MatrixSpace base class. | |
| Index | Dim () const |
| Accessor method for the dimension of the matrices in this matrix space. | |
| Public Member Functions inherited from Ipopt::MatrixSpace | |
| MatrixSpace (Index nRows, Index nCols) | |
| Constructor, given the number rows and columns of all matrices generated by this MatrixSpace. | |
| virtual | ~MatrixSpace () |
| Destructor. | |
| 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. | |
| 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 |
Accessor functions | |
| Index | nterms_ |
| std::vector< SmartPtr< const SymMatrixSpace > > | term_spaces_ |
| Index | NTerms () const |
| Number of terms in the sum. | |
| void | SetTermSpace (Index term_idx, const SymMatrixSpace &space) |
| Use this method to set the matrix spaces for the various terms. | |
| SmartPtr< const SymMatrixSpace > | GetTermSpace (Index term_idx) const |
| Get the matix space for a particular term. | |
| SumSymMatrix * | MakeNewSumSymMatrix () const |
| Method for creating a new matrix of this specific type. | |
| virtual SymMatrix * | MakeNewSymMatrix () const |
| Overloaded MakeNew method for the SymMatrixSpace base class. | |
Detailed Description
Class for matrix space for SumSymMatrix.
Definition at line 103 of file IpSumSymMatrix.hpp.
Constructor & Destructor Documentation
◆ SumSymMatrixSpace()
Constructor, given the dimension of the matrix and the number of terms in the sum.
Definition at line 110 of file IpSumSymMatrix.hpp.
◆ ~SumSymMatrixSpace()
|
inline |
Destructor.
Definition at line 117 of file IpSumSymMatrix.hpp.
Member Function Documentation
◆ NTerms()
|
inline |
Number of terms in the sum.
Definition at line 124 of file IpSumSymMatrix.hpp.
◆ SetTermSpace()
| void Ipopt::SumSymMatrixSpace::SetTermSpace | ( | Index | term_idx, |
| const SymMatrixSpace & | space | ||
| ) |
Use this method to set the matrix spaces for the various terms.
You will not be able to create a matrix until all these spaces are set.
◆ GetTermSpace()
| SmartPtr< const SymMatrixSpace > Ipopt::SumSymMatrixSpace::GetTermSpace | ( | Index | term_idx | ) | const |
Get the matix space for a particular term.
◆ MakeNewSumSymMatrix()
| SumSymMatrix * Ipopt::SumSymMatrixSpace::MakeNewSumSymMatrix | ( | ) | const |
Method for creating a new matrix of this specific type.
◆ MakeNewSymMatrix()
|
virtual |
Overloaded MakeNew method for the SymMatrixSpace base class.
Implements Ipopt::SymMatrixSpace.
Member Data Documentation
◆ nterms_
|
private |
Definition at line 146 of file IpSumSymMatrix.hpp.
◆ term_spaces_
|
private |
Definition at line 148 of file IpSumSymMatrix.hpp.
The documentation for this class was generated from the following file:
- src/LinAlg/IpSumSymMatrix.hpp
