Class for symmetric matrices stored in triplet format. More...

#include <IpSymTMatrix.hpp>

Inheritance diagram for Ipopt::SymTMatrix:

Public Member Functions
Constructors / Destructors
	SymTMatrix (const SymTMatrixSpace *owner_space)
	Constructor, taking the corresponding matrix space.

	~SymTMatrix ()
	Destructor.

Changing the Values.
void	SetValues (const Number *Values)
	Set values of nonzero elements.

Accessor Methods
Index	Nonzeros () const
	Number of nonzero entries.

const Index *	Irows () const
	Obtain pointer to the internal Index array irn_ without the intention to change the matrix data.

const Index *	Jcols () const
	Obtain pointer to the internal Index array jcn_ without the intention to change the matrix data.

Number *	Values ()
	Obtain pointer to the internal Number array values_ with the intention to change the matrix data.

const Number *	Values () const
	Obtain pointer to the internal Number array values_ without the intention to change the matrix data.

Methods for providing copy of the matrix data
void	FillStruct (Index Irn, Index Jcn) const
	Copy the nonzero structure into provided space.

void	FillValues (Number *Values) const
	Copy the value data into provided space.

Public Member Functions inherited from Ipopt::SymMatrix
SmartPtr< const SymMatrixSpace >	OwnerSymMatrixSpace () const

	SymMatrix (const SymMatrixSpace *owner_space)
	Constructor, taking the owner_space.

virtual	~SymMatrix ()
	Destructor.

Index	Dim () const
	Dimension of the matrix (number of rows and columns)

Public Member Functions inherited from Ipopt::Matrix
bool	HasValidNumbers () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

SmartPtr< const MatrixSpace >	OwnerSpace () const
	Return the owner MatrixSpace.

	Matrix (const MatrixSpace *owner_space)
	Constructor.

virtual	~Matrix ()
	Destructor.

void	MultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix-vector multiply.

void	TransMultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix(transpose) vector multiply.

void	AddMSinvZ (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = X + alpha*(Matrix S^{-1} Z).

void	SinvBlrmZMTdBr (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
	X = S^{-1} (r + alphaZM^Td).

Index	NRows () const
	Number of rows.

Index	NCols () const
	Number of columns.

void	ComputeRowAMax (Vector &rows_norms, bool init=true) const
	Compute the max-norm of the rows in the matrix.

void	ComputeColAMax (Vector &cols_norms, bool init=true) const
	Compute the max-norm of the columns in the matrix.

virtual void	Print (SmartPtr< const Journalist > jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const
	Print detailed information about the matrix.

virtual void	Print (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const

Public Member Functions inherited from Ipopt::TaggedObject
	TaggedObject ()
	Constructor.

virtual	~TaggedObject ()
	Destructor.

Tag	GetTag () const
	Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation.

bool	HasChanged (const Tag comparison_tag) const
	Users of TaggedObjects call this to check if the object HasChanged since they last updated their own internal tag.

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

Public Member Functions inherited from Ipopt::Subject
	Subject ()
	Default Constructor.

virtual	~Subject ()
	Destructor.

void	AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Attach the specified observer (i.e., begin receiving notifications).

void	DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
	Detach the specified observer (i.e., no longer receive notifications).

Protected Member Functions
Methods overloaded from matrix
virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix-vector multiply.

virtual bool	HasValidNumbersImpl () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

virtual void	ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
	Compute the max-norm of the rows in the matrix.

virtual void	PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
	Print detailed information about the matrix.

Protected Member Functions inherited from Ipopt::SymMatrix
virtual void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Implementation of TransMultVectorImpl, which calls MultVectorImpl.

virtual void	ComputeColAMaxImpl (Vector &cols_norms, bool init) const
	Implementation of ComputeColAMaxImpl, which calls ComputeRowAMaxImpl.

Protected Member Functions inherited from Ipopt::Matrix
virtual void	AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = X + alpha*(Matrix S^{-1} Z).

virtual void	SinvBlrmZMTdBrImpl (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
	X = S^{-1} (r + alphaZM^Td).

Protected Member Functions inherited from Ipopt::TaggedObject
void	ObjectChanged ()
	Objects derived from TaggedObject MUST call this method every time their internal state changes to update the internal tag for comparison.

Protected Member Functions inherited from Ipopt::Subject
void	Notify (Observer::NotifyType notify_type) 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.
	SymTMatrix ()
	Default Constructor.

	SymTMatrix (const SymTMatrix &)
	Copy Constructor.

void	operator= (const SymTMatrix &)
	Default Assignment Operator.

Private Attributes
const SymTMatrixSpace *	owner_space_
	Copy of the owner_space ptr as a SymTMatrixSpace instead of a MatrixSpace.

Number *	values_
	Values of nonzeros.

bool	initialized_
	Flag for Initialization.

Additional Inherited Members
Public Types inherited from Ipopt::TaggedObject
typedef unsigned int	Tag
	Type for the Tag values.

Detailed Description

Class for symmetric matrices stored in triplet format.

In the triplet format, the nonzeros elements of a symmetric matrix is stored in three arrays, Irn, Jcn, and Values, all of length Nonzeros. The first two arrays indicate the location of a non-zero element (as the row and column indices), and the last array stores the value at that location. Off-diagonal elements need to be stored only once since the matrix is symmetric. For example, the element \(a_{1,2}=a_{2,1}\) would be stored only once, either with Irn[i]=1 and Jcn[i]=2, or with Irn[i]=2 and Jcn[i]=1. Both representations are identical. If nonzero elements (or their symmetric counter part) are listed more than once, their values are added.

The structure of the nonzeros (i.e. the arrays Irn and Jcn) cannot be changed after the matrix can been initialized. Only the values of the nonzero elements can be modified.

Note that the first row and column of a matrix has index 1, not 0.

Definition at line 39 of file IpSymTMatrix.hpp.

Constructor & Destructor Documentation

◆ SymTMatrix() [1/3]

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

Constructor, taking the corresponding matrix space.

◆ ~SymTMatrix()

Ipopt::SymTMatrix::~SymTMatrix ( )

Destructor.

◆ SymTMatrix() [2/3]

Ipopt::SymTMatrix::SymTMatrix ( )

private

Default Constructor.

◆ SymTMatrix() [3/3]

Ipopt::SymTMatrix::SymTMatrix ( const SymTMatrix & )

private

Copy Constructor.

Member Function Documentation

◆ SetValues()

void Ipopt::SymTMatrix::SetValues ( const Number * Values )

Set values of nonzero elements.

The values of the nonzero elements is copied from the incoming Number array. Important: It is assume that the order of the values in Values corresponds to the one of Irn and Jcn given to the matrix space.

◆ Nonzeros()

Index Ipopt::SymTMatrix::Nonzeros ( ) const

inline

Number of nonzero entries.

Definition at line 259 of file IpSymTMatrix.hpp.

◆ Irows()

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

inline

Obtain pointer to the internal Index array irn_ without the intention to change the matrix data.

Attention: This does not produce a copy, and lifetime is not guaranteed!

Definition at line 264 of file IpSymTMatrix.hpp.

◆ Jcols()

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

inline

Obtain pointer to the internal Index array jcn_ without the intention to change the matrix data.

Attention: This does not produce a copy, and lifetime is not guaranteed!

Definition at line 269 of file IpSymTMatrix.hpp.

◆ Values() [1/2]

Number * Ipopt::SymTMatrix::Values ( )

Obtain pointer to the internal Number array values_ with the intention to change the matrix data.

Attention: This does not produce a copy, and lifetime is not guaranteed!

◆ Values() [2/2]

const Number * Ipopt::SymTMatrix::Values ( ) const

Obtain pointer to the internal Number array values_ without the intention to change the matrix data.

Attention: This does not produce a copy, and lifetime is not guaranteed!

◆ FillStruct()

void Ipopt::SymTMatrix::FillStruct	(	Index *	Irn,
		Index *	Jcn
	)		const

Copy the nonzero structure into provided space.

◆ FillValues()

void Ipopt::SymTMatrix::FillValues ( Number * Values ) const

Copy the value data into provided space.

◆ MultVectorImpl()

virtual void Ipopt::SymTMatrix::MultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)		const

protectedvirtual

Matrix-vector multiply.

Computes y = alpha * Matrix * x + beta * y.

Implements Ipopt::Matrix.

◆ HasValidNumbersImpl()

virtual bool Ipopt::SymTMatrix::HasValidNumbersImpl ( ) const

protectedvirtual

Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

A default implementation always returning true is provided, but if possible it should be implemented.

Reimplemented from Ipopt::Matrix.

◆ ComputeRowAMaxImpl()

virtual void Ipopt::SymTMatrix::ComputeRowAMaxImpl	(	Vector &	rows_norms,
		bool	init
	)		const

protectedvirtual

Compute the max-norm of the rows in the matrix.

The result is stored in rows_norms. The vector is assumed to be initialized if init is false.

Implements Ipopt::Matrix.

◆ PrintImpl()

virtual void Ipopt::SymTMatrix::PrintImpl	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent,
		const std::string &	prefix
	)		const

protectedvirtual

Print detailed information about the matrix.

Implements Ipopt::Matrix.

◆ operator=()

void Ipopt::SymTMatrix::operator= ( const SymTMatrix & )

private

Default Assignment Operator.

Member Data Documentation

◆ owner_space_

const SymTMatrixSpace* Ipopt::SymTMatrix::owner_space_

private

Copy of the owner_space ptr as a SymTMatrixSpace instead of a MatrixSpace.

Definition at line 169 of file IpSymTMatrix.hpp.

◆ values_

Number* Ipopt::SymTMatrix::values_

private

Values of nonzeros.

Definition at line 172 of file IpSymTMatrix.hpp.

◆ initialized_

bool Ipopt::SymTMatrix::initialized_

private

Flag for Initialization.

Definition at line 175 of file IpSymTMatrix.hpp.

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

src/LinAlg/TMatrices/IpSymTMatrix.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SymTMatrix() [1/3]

◆ ~SymTMatrix()

◆ SymTMatrix() [2/3]

◆ SymTMatrix() [3/3]

Member Function Documentation

◆ SetValues()

◆ Nonzeros()

◆ Irows()

◆ Jcols()

◆ Values() [1/2]

◆ Values() [2/2]

◆ FillStruct()

◆ FillValues()

◆ MultVectorImpl()

◆ HasValidNumbersImpl()

◆ ComputeRowAMaxImpl()

◆ PrintImpl()

◆ operator=()

Member Data Documentation

◆ owner_space_

◆ values_

◆ initialized_