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

#include <IpGenTMatrix.hpp>

Inheritance diagram for Ipopt::GenTMatrix:

Public Member Functions
Constructors / Destructors
	GenTMatrix (const GenTMatrixSpace *owner_space)
	Constructor, taking the owner_space.

	~GenTMatrix ()
	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
	Array with Row indices (counting starts at 1)

const Index *	Jcols () const
	Array with Column indices (counting starts at 1)

const Number *	Values () const
	Array with nonzero values (const version).

Number *	Values ()
	Array with the nonzero values of this matrix (non-const version).

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
void	PrintImplOffset (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix, Index offset) const

Overloaded methods from Matrix base class
virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix-vector multiply.

virtual void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Matrix(transpose) 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	ComputeColAMaxImpl (Vector &cols_norms, bool init) const
	Compute the max-norm of the columns 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::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.
	GenTMatrix ()
	Default Constructor.

	GenTMatrix (const GenTMatrix &)
	Copy Constructor.

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

Private Attributes
const GenTMatrixSpace *	owner_space_
	Copy of the owner space as a GenTMatrixSpace instead of a MatrixSpace.

Number *	values_
	Values of nonzeros.

bool	initialized_
	Flag for Initialization.

Friends
class	ParGenMatrix

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

Detailed Description

Class for general matrices stored in triplet format.

In the triplet format, the nonzeros elements of a general matrix is stored in three arrays, Irow, Jcol, and Values, all of length Nonzeros. The first two arrays indicate the location of a non-zero element (row and column indices), and the last array stores the value at that location. If nonzero elements are listed more than once, their values are added.

The structure of the nonzeros (i.e. the arrays Irow and Jcol) 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 34 of file IpGenTMatrix.hpp.

Constructor & Destructor Documentation

◆ GenTMatrix() [1/3]

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

Constructor, taking the owner_space.

◆ ~GenTMatrix()

Ipopt::GenTMatrix::~GenTMatrix ( )

Destructor.

◆ GenTMatrix() [2/3]

Ipopt::GenTMatrix::GenTMatrix ( )

private

Default Constructor.

◆ GenTMatrix() [3/3]

Ipopt::GenTMatrix::GenTMatrix ( const GenTMatrix & )

private

Copy Constructor.

Member Function Documentation

◆ SetValues()

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

Set values of nonzero elements.

The values of the nonzero elements are 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 one of the constructors above.

◆ Nonzeros()

Index Ipopt::GenTMatrix::Nonzeros ( ) const

inline

Number of nonzero entries.

Definition at line 274 of file IpGenTMatrix.hpp.

◆ Irows()

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

inline

Array with Row indices (counting starts at 1)

Definition at line 279 of file IpGenTMatrix.hpp.

◆ Jcols()

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

inline

Array with Column indices (counting starts at 1)

Definition at line 284 of file IpGenTMatrix.hpp.

◆ Values() [1/2]

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

inline

Array with nonzero values (const version).

Definition at line 75 of file IpGenTMatrix.hpp.

◆ Values() [2/2]

Number * Ipopt::GenTMatrix::Values ( )

inline

Array with the nonzero values of this matrix (non-const version).

Use this method only if you are intending to change the values, because the GenTMatrix will be marked as changed.

Definition at line 85 of file IpGenTMatrix.hpp.

◆ MultVectorImpl()

virtual void Ipopt::GenTMatrix::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.

◆ TransMultVectorImpl()

virtual void Ipopt::GenTMatrix::TransMultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)		const

protectedvirtual

Matrix(transpose) vector multiply.

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

Implements Ipopt::Matrix.

◆ HasValidNumbersImpl()

virtual bool Ipopt::GenTMatrix::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::GenTMatrix::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.

◆ ComputeColAMaxImpl()

virtual void Ipopt::GenTMatrix::ComputeColAMaxImpl	(	Vector &	cols_norms,
		bool	init
	)		const

protectedvirtual

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

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

Implements Ipopt::Matrix.

◆ PrintImpl()

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

inlineprotectedvirtual

Print detailed information about the matrix.

Implements Ipopt::Matrix.

Definition at line 122 of file IpGenTMatrix.hpp.

◆ PrintImplOffset()

void Ipopt::GenTMatrix::PrintImplOffset	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent,
		const std::string &	prefix,
		Index	offset
	)		const

protected

◆ operator=()

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

private

Default Assignment Operator.

Friends And Related Symbol Documentation

◆ ParGenMatrix

friend class ParGenMatrix

friend

Definition at line 145 of file IpGenTMatrix.hpp.

Member Data Documentation

◆ owner_space_

const GenTMatrixSpace* Ipopt::GenTMatrix::owner_space_

private

Copy of the owner space as a GenTMatrixSpace instead of a MatrixSpace.

Definition at line 174 of file IpGenTMatrix.hpp.

◆ values_

Number* Ipopt::GenTMatrix::values_

private

Values of nonzeros.

Definition at line 177 of file IpGenTMatrix.hpp.

◆ initialized_

bool Ipopt::GenTMatrix::initialized_

private

Flag for Initialization.

Definition at line 180 of file IpGenTMatrix.hpp.

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

src/LinAlg/TMatrices/IpGenTMatrix.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenTMatrix() [1/3]

◆ ~GenTMatrix()

◆ GenTMatrix() [2/3]

◆ GenTMatrix() [3/3]

Member Function Documentation

◆ SetValues()

◆ Nonzeros()

◆ Irows()

◆ Jcols()

◆ Values() [1/2]

◆ Values() [2/2]

◆ MultVectorImpl()

◆ TransMultVectorImpl()

◆ HasValidNumbersImpl()

◆ ComputeRowAMaxImpl()

◆ ComputeColAMaxImpl()

◆ PrintImpl()

◆ PrintImplOffset()

◆ operator=()

Friends And Related Symbol Documentation

◆ ParGenMatrix

Member Data Documentation

◆ owner_space_

◆ values_

◆ initialized_