Ipopt::SumSymMatrixSpace Class Reference

Class for matrix space for SumSymMatrix. More...

#include <IpSumSymMatrix.hpp>

Inheritance diagram for Ipopt::SumSymMatrixSpace:

Public Member Functions
void	SetTermSpace (Index term_idx, const SymMatrixSpace &space)
	Use this method to set the matrix spaces for the various terms.
SmartPtr< const SymMatrixSpace >	GetTermSpace (Index term_idx) const
	Get the matrix space for a particular term.
SumSymMatrix *	MakeNewSumSymMatrix () const
	Method for creating a new matrix of this specific type.
virtual SymMatrix *	MakeNewSymMatrix () const
	Pure virtual method for creating a new matrix of this specific type.
Constructors / Destructors
	SumSymMatrixSpace (Index ndim, Index nterms)
	Constructor, given the dimension of the matrix and the number of terms in the sum.
	~SumSymMatrixSpace ()
	Destructor.
Accessor functions
Index	NTerms () const
	Number of terms in the sum.
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 Attributes
Index	nterms_
std::vector< SmartPtr< const SymMatrixSpace > >	term_spaces_

Detailed Description

Class for matrix space for SumSymMatrix.

Definition at line 129 of file IpSumSymMatrix.hpp.

Constructor & Destructor Documentation

SumSymMatrixSpace()

Ipopt::SumSymMatrixSpace::SumSymMatrixSpace ( Index  ndim, Index  nterms  )

inline

Constructor, given the dimension of the matrix and the number of terms in the sum.

Definition at line 137 of file IpSumSymMatrix.hpp.

~SumSymMatrixSpace()

Ipopt::SumSymMatrixSpace::~SumSymMatrixSpace ( )

inline

Destructor.

Definition at line 146 of file IpSumSymMatrix.hpp.

Member Function Documentation

NTerms()

Index Ipopt::SumSymMatrixSpace::NTerms ( ) const

inline

Number of terms in the sum.

Definition at line 153 of file IpSumSymMatrix.hpp.

SetTermSpace()

void Ipopt::SumSymMatrixSpace::SetTermSpace	(	Index	term_idx,
		const SymMatrixSpace &	space
	)

Use this method to set the matrix spaces for the various terms.

You will not be able to create a matrix until all these spaces are set.

GetTermSpace()

SmartPtr< const SymMatrixSpace > Ipopt::SumSymMatrixSpace::GetTermSpace

(

Index

term_idx

)

const

Get the matrix space for a particular term.

MakeNewSumSymMatrix()

SumSymMatrix * Ipopt::SumSymMatrixSpace::MakeNewSumSymMatrix

(

)

const

Method for creating a new matrix of this specific type.

MakeNewSymMatrix()

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

virtual

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

Implements Ipopt::SymMatrixSpace.

Member Data Documentation

nterms_

Index Ipopt::SumSymMatrixSpace::nterms_

private

Definition at line 180 of file IpSumSymMatrix.hpp.

term_spaces_

std::vector<SmartPtr<const SymMatrixSpace> > Ipopt::SumSymMatrixSpace::term_spaces_

private

Definition at line 182 of file IpSumSymMatrix.hpp.

---

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

• src/LinAlg/IpSumSymMatrix.hpp