Ipopt  3.12.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | Friends | List of all members
Ipopt::SymTMatrixSpace Class Reference

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

#include <IpSymTMatrix.hpp>

+ Inheritance diagram for Ipopt::SymTMatrixSpace:

Public Member Functions

virtual SymMatrixMakeNewSymMatrix () const
 Overloaded MakeNew method for the sYMMatrixSpace base class. More...
 
SymTMatrixMakeNewSymTMatrix () const
 Method for creating a new matrix of this specific type. More...
 
Constructors / Destructors
 SymTMatrixSpace (Index dim, Index nonZeros, const Index *iRows, const Index *jCols)
 Constructor, given the number of rows and columns (both as dim), as well as the number of nonzeros and the position of the nonzero elements. More...
 
 ~SymTMatrixSpace ()
 Destructor. More...
 
Methods describing Matrix structure
Index Nonzeros () const
 Number of non-zeros in the sparse matrix. More...
 
const IndexIrows () const
 Row index of each non-zero element. More...
 
const IndexJcols () const
 Column index of each non-zero element. More...
 
- Public Member Functions inherited from Ipopt::SymMatrixSpace
virtual MatrixMakeNew () const
 Overloaded MakeNew method for the MatrixSpace base class. More...
 
Index Dim () const
 Accessor method for the dimension of the matrices in this matrix space. More...
 
 SymMatrixSpace (Index dim)
 Constructor, given the dimension (identical to the number of rows and columns). More...
 
virtual ~SymMatrixSpace ()
 Destructor. More...
 
- Public Member Functions inherited from Ipopt::MatrixSpace
Index NRows () const
 Accessor function for the number of rows. More...
 
Index NCols () const
 Accessor function for the number of columns. More...
 
bool IsMatrixFromSpace (const Matrix &matrix) const
 Method to test if a given matrix belongs to a particular matrix space. More...
 
 MatrixSpace (Index nRows, Index nCols)
 Constructor, given the number rows and columns of all matrices generated by this MatrixSpace. More...
 
virtual ~MatrixSpace ()
 Destructor. More...
 
- 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
 

Private Member Functions

Methods called by SymTMatrix for memory management
NumberAllocateInternalStorage () const
 Allocate internal storage for the SymTMatrix values. More...
 
void FreeInternalStorage (Number *values) const
 Deallocate internal storage for the SymTMatrix values. More...
 

Private Attributes

const Index nonZeros_
 
IndexiRows_
 
IndexjCols_
 

Friends

class SymTMatrix
 

Detailed Description

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

The sparsity structure is stored here in the matrix space.

Definition at line 161 of file IpSymTMatrix.hpp.

Constructor & Destructor Documentation

Ipopt::SymTMatrixSpace::SymTMatrixSpace ( Index  dim,
Index  nonZeros,
const Index iRows,
const Index jCols 
)

Constructor, given the number of rows and columns (both as dim), 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. Off-diagonal elements are stored only once.

Ipopt::SymTMatrixSpace::~SymTMatrixSpace ( )

Destructor.

Member Function Documentation

virtual SymMatrix* Ipopt::SymTMatrixSpace::MakeNewSymMatrix ( ) const
inlinevirtual

Overloaded MakeNew method for the sYMMatrixSpace base class.

Implements Ipopt::SymMatrixSpace.

Definition at line 183 of file IpSymTMatrix.hpp.

SymTMatrix* Ipopt::SymTMatrixSpace::MakeNewSymTMatrix ( ) const
inline

Method for creating a new matrix of this specific type.

Definition at line 189 of file IpSymTMatrix.hpp.

Index Ipopt::SymTMatrixSpace::Nonzeros ( ) const
inline

Number of non-zeros in the sparse matrix.

Definition at line 197 of file IpSymTMatrix.hpp.

const Index* Ipopt::SymTMatrixSpace::Irows ( ) const
inline

Row index of each non-zero element.

Definition at line 203 of file IpSymTMatrix.hpp.

const Index* Ipopt::SymTMatrixSpace::Jcols ( ) const
inline

Column index of each non-zero element.

Definition at line 209 of file IpSymTMatrix.hpp.

Number* Ipopt::SymTMatrixSpace::AllocateInternalStorage ( ) const
private

Allocate internal storage for the SymTMatrix values.

void Ipopt::SymTMatrixSpace::FreeInternalStorage ( Number values) const
private

Deallocate internal storage for the SymTMatrix values.

Friends And Related Function Documentation

friend class SymTMatrix
friend

Definition at line 229 of file IpSymTMatrix.hpp.

Member Data Documentation

const Index Ipopt::SymTMatrixSpace::nonZeros_
private

Definition at line 225 of file IpSymTMatrix.hpp.

Index* Ipopt::SymTMatrixSpace::iRows_
private

Definition at line 226 of file IpSymTMatrix.hpp.

Index* Ipopt::SymTMatrixSpace::jCols_
private

Definition at line 227 of file IpSymTMatrix.hpp.


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