Public Member Functions | Private Member Functions | Friends
Ipopt::GenTMatrixSpace Class Reference

This is the matrix space for a GenTMatrix with fixed sparsity structure. More...

#include <IpGenTMatrix.hpp>

Inheritance diagram for Ipopt::GenTMatrixSpace:
Ipopt::MatrixSpace Ipopt::ReferencedObject

List of all members.

Public Member Functions

GenTMatrixMakeNewGenTMatrix () const
 Method for creating a new matrix of this specific type.
virtual MatrixMakeNew () 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 IndexIrows () const
 Row index of each non-zero element (counting starts at 1)
const IndexJcols () const
 Column index of each non-zero element (counting starts at 1)

Private Member Functions

NumberAllocateInternalStorage () 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

space.

const Index nonZeros_
IndexjCols_
IndexiRows_

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 164 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 181 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 189 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 196 of file IpGenTMatrix.hpp.

Index Ipopt::GenTMatrixSpace::Nonzeros ( ) const [inline]

Number of non-zeros in the sparse matrix.

Definition at line 204 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 210 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 216 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 240 of file IpGenTMatrix.hpp.


Member Data Documentation

Definition at line 227 of file IpGenTMatrix.hpp.

Definition at line 228 of file IpGenTMatrix.hpp.

Definition at line 229 of file IpGenTMatrix.hpp.


The documentation for this class was generated from the following file: