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 SymMatrix *	MakeNewSymMatrix () const
	Pure virtual method for creating a new matrix of this specific type.
SymTMatrix *	MakeNewSymTMatrix () const
	Method for creating a new matrix of this specific type.
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.
	~SymTMatrixSpace ()
	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.
const Index *	Jcols () const
	Column index of each non-zero element.
Public Member Functions inherited from Ipopt::SymMatrixSpace
virtual Matrix *	MakeNew () const
	Pure virtual method for creating a new Matrix of the corresponding type.
Index	Dim () const
	Accessor method for the dimension of the matrices in this matrix space.
	SymMatrixSpace (Index dim)
	Constructor, given the dimension (identical to the number of rows and columns).
virtual	~SymMatrixSpace ()
	Destructor.
Public Member Functions inherited from Ipopt::MatrixSpace
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.
	MatrixSpace (Index nRows, Index nCols)
	Constructor, given the number rows and columns of all matrices generated by this MatrixSpace.
virtual	~MatrixSpace ()
	Destructor.
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
Number *	AllocateInternalStorage () const
	Allocate internal storage for the SymTMatrix values.
void	FreeInternalStorage (Number *values) const
	Deallocate internal storage for the SymTMatrix values.

Private Attributes
const Index	nonZeros_
Index *	iRows_
Index *	jCols_

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 183 of file IpSymTMatrix.hpp.

Constructor & Destructor Documentation

SymTMatrixSpace()

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.

~SymTMatrixSpace()

Ipopt::SymTMatrixSpace::~SymTMatrixSpace

(

)

Destructor.

Member Function Documentation

MakeNewSymMatrix()

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

inlinevirtual

Pure virtual method for creating a new matrix of this specific type.

Implements Ipopt::SymMatrixSpace.

Definition at line 207 of file IpSymTMatrix.hpp.

MakeNewSymTMatrix()

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

inline

Method for creating a new matrix of this specific type.

Definition at line 213 of file IpSymTMatrix.hpp.

Nonzeros()

Index Ipopt::SymTMatrixSpace::Nonzeros ( ) const

inline

Number of non-zeros in the sparse matrix.

Definition at line 221 of file IpSymTMatrix.hpp.

Irows()

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

inline

Row index of each non-zero element.

Definition at line 227 of file IpSymTMatrix.hpp.

Jcols()

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

inline

Column index of each non-zero element.

Definition at line 233 of file IpSymTMatrix.hpp.

AllocateInternalStorage()

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

private

Allocate internal storage for the SymTMatrix values.

FreeInternalStorage()

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

private

Deallocate internal storage for the SymTMatrix values.

Friends And Related Symbol Documentation

SymTMatrix

friend class SymTMatrix

friend

Definition at line 255 of file IpSymTMatrix.hpp.

Member Data Documentation

nonZeros_

const Index Ipopt::SymTMatrixSpace::nonZeros_

private

Definition at line 251 of file IpSymTMatrix.hpp.

iRows_

Index* Ipopt::SymTMatrixSpace::iRows_

private

Definition at line 252 of file IpSymTMatrix.hpp.

jCols_

Index* Ipopt::SymTMatrixSpace::jCols_

private

Definition at line 253 of file IpSymTMatrix.hpp.

---

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

• src/LinAlg/TMatrices/IpSymTMatrix.hpp