Ipopt::GenTMatrixSpace Class Reference
This is the matrix space for a GenTMatrix with fixed sparsity structure. More...
#include <IpGenTMatrix.hpp>
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). | |
Private Member Functions | |
| Number * | AllocateInternalStorage () const |
| This method is only for the GenTMatrix to call in order to allocate internal storage. | |
| void | FreeInternalStorage (Number *values) const |
| This method is only for the GenTMatrix to call in order to de-allocate internal storage. | |
Private Attributes | |
Sparsity structure of matrices generated by this matrix | |
| const Index | nonZeros_ |
| Index * | jCols_ |
| Index * | iRows_ |
Friends | |
| class | GenTMatrix |
Detailed Description
This is the matrix space for a GenTMatrix with fixed sparsity structure.
The sparsity structure is stored here in the matrix space.
Definition at line 148 of file IpGenTMatrix.hpp.
Constructor & Destructor Documentation
| Ipopt::GenTMatrixSpace::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.
| Ipopt::GenTMatrixSpace::~GenTMatrixSpace | ( | ) | [inline] |
Destructor.
Definition at line 165 of file IpGenTMatrix.hpp.
Member Function Documentation
| GenTMatrix* Ipopt::GenTMatrixSpace::MakeNewGenTMatrix | ( | ) | const [inline] |
Method for creating a new matrix of this specific type.
Definition at line 173 of file IpGenTMatrix.hpp.
| virtual Matrix* Ipopt::GenTMatrixSpace::MakeNew | ( | ) | const [inline, virtual] |
Overloaded MakeNew method for the MatrixSpace base class.
Implements Ipopt::MatrixSpace.
Definition at line 180 of file IpGenTMatrix.hpp.
| Index Ipopt::GenTMatrixSpace::Nonzeros | ( | ) | const [inline] |
Number of non-zeros in the sparse matrix.
Definition at line 188 of file IpGenTMatrix.hpp.
| const Index* Ipopt::GenTMatrixSpace::Irows | ( | ) | const [inline] |
Row index of each non-zero element (counting starts at 1).
Definition at line 194 of file IpGenTMatrix.hpp.
| const Index* Ipopt::GenTMatrixSpace::Jcols | ( | ) | const [inline] |
Column index of each non-zero element (counting starts at 1).
Definition at line 200 of file IpGenTMatrix.hpp.
| Number* Ipopt::GenTMatrixSpace::AllocateInternalStorage | ( | ) | const [private] |
This method is only for the GenTMatrix to call in order to allocate internal storage.
| void Ipopt::GenTMatrixSpace::FreeInternalStorage | ( | Number * | values | ) | const [private] |
This method is only for the GenTMatrix to call in order to de-allocate internal storage.
Friends And Related Function Documentation
friend class GenTMatrix [friend] |
Definition at line 224 of file IpGenTMatrix.hpp.
Member Data Documentation
const Index Ipopt::GenTMatrixSpace::nonZeros_ [private] |
Definition at line 211 of file IpGenTMatrix.hpp.
Index* Ipopt::GenTMatrixSpace::jCols_ [private] |
Definition at line 212 of file IpGenTMatrix.hpp.
Index* Ipopt::GenTMatrixSpace::iRows_ [private] |
Definition at line 213 of file IpGenTMatrix.hpp.
The documentation for this class was generated from the following file:
- /home/coin/svn-release/OptimizationSuite-1.1.0/Ipopt/src/LinAlg/TMatrices/IpGenTMatrix.hpp
