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:

Public Member Functions
GenTMatrix *	MakeNewGenTMatrix () const
	Method for creating a new matrix of this specific type.
virtual Matrix *	MakeNew () const
	Pure virtual method for creating a new Matrix of the corresponding type.
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)
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
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 space.
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 188 of file IpGenTMatrix.hpp.

Constructor & Destructor Documentation

GenTMatrixSpace()

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.

~GenTMatrixSpace()

Ipopt::GenTMatrixSpace::~GenTMatrixSpace ( )

inline

Destructor.

Definition at line 211 of file IpGenTMatrix.hpp.

Member Function Documentation

MakeNewGenTMatrix()

GenTMatrix * Ipopt::GenTMatrixSpace::MakeNewGenTMatrix ( ) const

inline

Method for creating a new matrix of this specific type.

Definition at line 219 of file IpGenTMatrix.hpp.

MakeNew()

virtual Matrix * Ipopt::GenTMatrixSpace::MakeNew ( ) const

inlinevirtual

Pure virtual method for creating a new Matrix of the corresponding type.

Implements Ipopt::MatrixSpace.

Definition at line 224 of file IpGenTMatrix.hpp.

Nonzeros()

Index Ipopt::GenTMatrixSpace::Nonzeros ( ) const

inline

Number of non-zeros in the sparse matrix.

Definition at line 232 of file IpGenTMatrix.hpp.

Irows()

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

inline

Row index of each non-zero element (counting starts at 1)

Definition at line 238 of file IpGenTMatrix.hpp.

Jcols()

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

inline

Column index of each non-zero element (counting starts at 1)

Definition at line 244 of file IpGenTMatrix.hpp.

AllocateInternalStorage()

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

private

This method is only for the GenTMatrix to call in order to allocate internal storage.

FreeInternalStorage()

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 Symbol Documentation

GenTMatrix

friend class GenTMatrix

friend

Definition at line 270 of file IpGenTMatrix.hpp.

Member Data Documentation

nonZeros_

const Index Ipopt::GenTMatrixSpace::nonZeros_

private

Definition at line 253 of file IpGenTMatrix.hpp.

jCols_

Index* Ipopt::GenTMatrixSpace::jCols_

private

Definition at line 254 of file IpGenTMatrix.hpp.

iRows_

Index* Ipopt::GenTMatrixSpace::iRows_

private

Definition at line 255 of file IpGenTMatrix.hpp.

---

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

• src/LinAlg/TMatrices/IpGenTMatrix.hpp