Ipopt::SumMatrixSpace Class Reference

Class for matrix space for SumMatrix. More...

#include <IpSumMatrix.hpp>

Inheritance diagram for Ipopt::SumMatrixSpace:

Public Member Functions
Index	NTerms () const
	Accessor functions to get the number of terms in the sum.
void	SetTermSpace (Index term_idx, const MatrixSpace &mat_space)
	Set the appropriate matrix space for each term.
SmartPtr< const MatrixSpace >	GetTermSpace (Index term_idx) const
	Get the matrix space for a particular term.
SumMatrix *	MakeNewSumMatrix () 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
	SumMatrixSpace (Index nrows, Index ncols, Index nterms)
	Constructor, given the number of row and columns, as well as the number of terms in the sum.
virtual	~SumMatrixSpace ()
	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
Default Compiler Generated Methods
(Hidden to avoid implicit creation/calling). These methods are not implemented and we do not want the compiler to implement them for us, so we declare them private and do not define them. This ensures that they will not be implicitly created/called.
	SumMatrixSpace ()
	Default constructor.
	SumMatrixSpace (const SumMatrixSpace &)
	Copy Constructor.
SumMatrixSpace &	operator= (const SumMatrixSpace &)
	Default Assignment Operator.

Private Attributes
const Index	nterms_
std::vector< SmartPtr< const MatrixSpace > >	term_spaces_

Detailed Description

Class for matrix space for SumMatrix.

Definition at line 131 of file IpSumMatrix.hpp.

Constructor & Destructor Documentation

SumMatrixSpace() [1/3]

Ipopt::SumMatrixSpace::SumMatrixSpace ( Index  nrows, Index  ncols, Index  nterms  )

inline

Constructor, given the number of row and columns, as well as the number of terms in the sum.

Definition at line 139 of file IpSumMatrix.hpp.

~SumMatrixSpace()

virtual Ipopt::SumMatrixSpace::~SumMatrixSpace ( )

inlinevirtual

Destructor.

Definition at line 149 of file IpSumMatrix.hpp.

SumMatrixSpace() [2/3]

Ipopt::SumMatrixSpace::SumMatrixSpace ( )

private

Default constructor.

SumMatrixSpace() [3/3]

Ipopt::SumMatrixSpace::SumMatrixSpace ( const SumMatrixSpace &  )

private

Copy Constructor.

Member Function Documentation

NTerms()

Index Ipopt::SumMatrixSpace::NTerms ( ) const

inline

Accessor functions to get the number of terms in the sum.

Definition at line 154 of file IpSumMatrix.hpp.

SetTermSpace()

void Ipopt::SumMatrixSpace::SetTermSpace	(	Index	term_idx,
		const MatrixSpace &	mat_space
	)

Set the appropriate matrix space for each term.

This must be called for each term or a runtime error will occur.

GetTermSpace()

SmartPtr< const MatrixSpace > Ipopt::SumMatrixSpace::GetTermSpace

(

Index

term_idx

)

const

Get the matrix space for a particular term.

MakeNewSumMatrix()

SumMatrix * Ipopt::SumMatrixSpace::MakeNewSumMatrix

(

)

const

Method for creating a new matrix of this specific type.

MakeNew()

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

virtual

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

Implements Ipopt::MatrixSpace.

operator=()

SumMatrixSpace & Ipopt::SumMatrixSpace::operator= ( const SumMatrixSpace &  )

private

Default Assignment Operator.

Member Data Documentation

nterms_

const Index Ipopt::SumMatrixSpace::nterms_

private

Definition at line 202 of file IpSumMatrix.hpp.

term_spaces_

std::vector<SmartPtr<const MatrixSpace> > Ipopt::SumMatrixSpace::term_spaces_

private

Definition at line 204 of file IpSumMatrix.hpp.

---

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

• src/LinAlg/IpSumMatrix.hpp