GenTMatrixSpace Class Reference
#include <IpGenTMatrix.hpp>
Inheritance diagram for GenTMatrixSpace:
Detailed Description
This is the matrix space for a GenTMatrix with fixed sparsity structure.The sparsity structure is stored here in the matrix space.
Public Member Functions | |
| GenTMatrix * | MakeNewGenTMatrix () const |
| Method for creating a new matrix of this specific type. | |
| virtual Matrix * | MakeNew () const |
| Overloaded MakeNew method for the MatrixSpace base class. | |
Constructors / Destructors | |
| GenTMatrixSpace (Index nRows, Index nCols, Index nonZeros, const Index *iRows, const Index *jCols) | |
| Constructor, given the number of rows and columns, as well as the number of nonzeros and the position of the nonzero elements. | |
| ~GenTMatrixSpace () | |
| Destructor. | |
Methods describing Matrix structure | |
| Index | Nonzeros () const |
| Number of non-zeros in the sparse matrix. | |
| const Index * | Irows () const |
| Row index of each non-zero element (counting starts at 1). | |
| const Index * | Jcols () const |
| Column index of each non-zero element (counting starts at 1). | |
Friends | |
| class | GenTMatrix |
Constructor & Destructor Documentation
| GenTMatrixSpace | ( | Index | nRows, | |
| Index | nCols, | |||
| Index | nonZeros, | |||
| const Index * | iRows, | |||
| const Index * | jCols | |||
| ) |
Constructor, given the number of rows and columns, as well as the number of nonzeros and the position of the nonzero elements.
Note that the counting of the nonzeros starts a 1, i.e., iRows[i]==1 and jCols[i]==1 refers to the first element in the first row. This is in accordance with the HSL data structure.
References fkinkryx::i.
| ~GenTMatrixSpace | ( | ) | [inline] |
Destructor.
Member Function Documentation
| GenTMatrix* MakeNewGenTMatrix | ( | ) | const [inline] |
Method for creating a new matrix of this specific type.
References GenTMatrixSpace::GenTMatrix.
Referenced by GenTMatrixSpace::MakeNew().
| virtual Matrix* MakeNew | ( | ) | const [inline, virtual] |
Overloaded MakeNew method for the MatrixSpace base class.
Implements MatrixSpace.
References GenTMatrixSpace::MakeNewGenTMatrix().
| Index Nonzeros | ( | ) | const [inline] |
| const Index* Irows | ( | ) | const [inline] |
| const Index* Jcols | ( | ) | const [inline] |
Friends And Related Function Documentation
friend class GenTMatrix [friend] |
Referenced by GenTMatrixSpace::MakeNewGenTMatrix().
The documentation for this class was generated from the following files:
