#include <IpMatrix.hpp>

Inheritance diagram for Ipopt::Matrix:

Public Member Functions
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.

Constructor/Destructor
	Matrix (const MatrixSpace *owner_space)
	Constructor.

virtual	~Matrix ()
	Destructor.

Operations of the Matrix on a Vector
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.

Methods for specialized operations.
A prototype implementation is provided, but for efficient implementation those should be specially implemented.
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).

Information about the size of the matrix
Index	NRows () const
	Number of rows.

Index	NCols () const
	Number of columns.

Norms of the individual rows and 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
implementation methods (derived classes MUST
overload these pure virtual protected methods).
virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const =0
	Matrix-vector multiply.

virtual void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const =0
	Matrix(transpose) vector multiply.

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).

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 =0
	Compute the max-norm of the rows in the matrix.

virtual void	ComputeColAMaxImpl (Vector &cols_norms, bool init) const =0
	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 =0
	Print detailed information about the matrix.

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.
	Matrix ()
	Default constructor.

	Matrix (const Matrix &)
	Copy constructor.

Matrix &	operator= (const Matrix &)
	Default Assignment Operator.

Private Attributes
const SmartPtr< const MatrixSpace >	owner_space_

CachedResults data members
TaggedObject::Tag	valid_cache_tag_

bool	cached_valid_

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

Detailed Description

Matrix Base Class.

This is the base class for all derived matrix types. All Matrices, such as Jacobian and Hessian matrices, as well as possibly the iteration matrices needed for the step computation, are of this type.

Deriving from Matrix: Overload the protected XXX_Impl method.

Definition at line 27 of file IpMatrix.hpp.

Constructor & Destructor Documentation

◆ Matrix() [1/3]

Ipopt::Matrix::Matrix ( const MatrixSpace * owner_space )

inline

Constructor.

It has to be given a pointer to the corresponding MatrixSpace.

Definition at line 36 of file IpMatrix.hpp.

◆ ~Matrix()

virtual Ipopt::Matrix::~Matrix ( )

inlinevirtual

Destructor.

Definition at line 45 of file IpMatrix.hpp.

◆ Matrix() [2/3]

Ipopt::Matrix::Matrix ( )

private

Default constructor.

◆ Matrix() [3/3]

Ipopt::Matrix::Matrix ( const Matrix & )

private

Copy constructor.

Member Function Documentation

◆ MultVector()

void Ipopt::Matrix::MultVector	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)		const

inline

Matrix-vector multiply.

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

Attention: Do not overload. Overload MultVectorImpl instead.

Definition at line 57 of file IpMatrix.hpp.

◆ TransMultVector()

void Ipopt::Matrix::TransMultVector	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)		const

inline

Matrix(transpose) vector multiply.

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

Attention: Do not overload. Overload TransMultVectorImpl instead.

Definition at line 73 of file IpMatrix.hpp.

◆ AddMSinvZ()

void Ipopt::Matrix::AddMSinvZ	(	Number	alpha,
		const Vector &	S,
		const Vector &	Z,
		Vector &	X
	)		const

X = X + alpha*(Matrix S^{-1} Z).

Should be implemented efficiently for the ExpansionMatrix.

◆ SinvBlrmZMTdBr()

void Ipopt::Matrix::SinvBlrmZMTdBr	(	Number	alpha,
		const Vector &	S,
		const Vector &	R,
		const Vector &	Z,
		const Vector &	D,
		Vector &	X
	)		const

X = S^{-1} (r + alpha*Z*M^Td).

Should be implemented efficiently for the ExpansionMatrix.

◆ HasValidNumbers()

bool Ipopt::Matrix::HasValidNumbers ( ) const

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

◆ NRows()

Index Ipopt::Matrix::NRows ( ) const

inline

Number of rows.

Definition at line 401 of file IpMatrix.hpp.

◆ NCols()

Index Ipopt::Matrix::NCols ( ) const

inline

Number of columns.

Definition at line 406 of file IpMatrix.hpp.

◆ ComputeRowAMax()

void Ipopt::Matrix::ComputeRowAMax	(	Vector &	rows_norms,
		bool	init = `true`
	)		const

inline

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.

Definition at line 134 of file IpMatrix.hpp.

◆ ComputeColAMax()

void Ipopt::Matrix::ComputeColAMax	(	Vector &	cols_norms,
		bool	init = `true`
	)		const

inline

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.

Definition at line 152 of file IpMatrix.hpp.

◆ Print() [1/2]

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

virtual

Print detailed information about the matrix.

Attention: Do not overload. Overload PrintImpl instead.

◆ Print() [2/2]

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

virtual

◆ OwnerSpace()

SmartPtr< const MatrixSpace > Ipopt::Matrix::OwnerSpace ( ) const

inline

Return the owner MatrixSpace.

Definition at line 411 of file IpMatrix.hpp.

◆ MultVectorImpl()

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

protectedpure virtual

Matrix-vector multiply.

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

Implemented in Ipopt::CompoundMatrix, Ipopt::CompoundSymMatrix, Ipopt::DenseGenMatrix, Ipopt::DenseSymMatrix, Ipopt::DiagMatrix, Ipopt::ExpandedMultiVectorMatrix, Ipopt::ExpansionMatrix, Ipopt::IdentityMatrix, Ipopt::LowRankUpdateSymMatrix, Ipopt::MultiVectorMatrix, Ipopt::ScaledMatrix, Ipopt::SumMatrix, Ipopt::SumSymMatrix, Ipopt::SymScaledMatrix, Ipopt::TransposeMatrix, Ipopt::ZeroMatrix, Ipopt::ZeroSymMatrix, Ipopt::GenTMatrix, and Ipopt::SymTMatrix.

◆ TransMultVectorImpl()

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

protectedpure virtual

Matrix(transpose) vector multiply.

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

Implemented in Ipopt::CompoundMatrix, Ipopt::DenseGenMatrix, Ipopt::ExpandedMultiVectorMatrix, Ipopt::ExpansionMatrix, Ipopt::MultiVectorMatrix, Ipopt::ScaledMatrix, Ipopt::SumMatrix, Ipopt::SymMatrix, Ipopt::TransposeMatrix, Ipopt::ZeroMatrix, Ipopt::ZeroSymMatrix, and Ipopt::GenTMatrix.

◆ AddMSinvZImpl()

virtual void Ipopt::Matrix::AddMSinvZImpl	(	Number	alpha,
		const Vector &	S,
		const Vector &	Z,
		Vector &	X
	)		const

protectedvirtual

X = X + alpha*(Matrix S^{-1} Z).

Prototype for this specialize method is provided, but for efficient implementation it should be overloaded for the expansion matrix.

Reimplemented in Ipopt::CompoundMatrix, Ipopt::ExpansionMatrix, Ipopt::IdentityMatrix, and Ipopt::ScaledMatrix.

◆ SinvBlrmZMTdBrImpl()

virtual void Ipopt::Matrix::SinvBlrmZMTdBrImpl	(	Number	alpha,
		const Vector &	S,
		const Vector &	R,
		const Vector &	Z,
		const Vector &	D,
		Vector &	X
	)		const

protectedvirtual

X = S^{-1} (r + alpha*Z*M^Td).

Should be implemented efficiently for the ExpansionMatrix.

Reimplemented in Ipopt::CompoundMatrix, Ipopt::ExpansionMatrix, and Ipopt::ScaledMatrix.

◆ HasValidNumbersImpl()

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

inlineprotectedvirtual

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 in Ipopt::CompoundMatrix, Ipopt::CompoundSymMatrix, Ipopt::DenseGenMatrix, Ipopt::DenseSymMatrix, Ipopt::DiagMatrix, Ipopt::ExpandedMultiVectorMatrix, Ipopt::IdentityMatrix, Ipopt::LowRankUpdateSymMatrix, Ipopt::MultiVectorMatrix, Ipopt::ScaledMatrix, Ipopt::SumMatrix, Ipopt::SumSymMatrix, Ipopt::SymScaledMatrix, Ipopt::TransposeMatrix, Ipopt::GenTMatrix, and Ipopt::SymTMatrix.

Definition at line 250 of file IpMatrix.hpp.

◆ ComputeRowAMaxImpl()

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

protectedpure virtual

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.

Implemented in Ipopt::ZeroMatrix, Ipopt::ZeroSymMatrix, Ipopt::CompoundMatrix, Ipopt::CompoundSymMatrix, Ipopt::DenseGenMatrix, Ipopt::DenseSymMatrix, Ipopt::DiagMatrix, Ipopt::ExpandedMultiVectorMatrix, Ipopt::ExpansionMatrix, Ipopt::IdentityMatrix, Ipopt::LowRankUpdateSymMatrix, Ipopt::MultiVectorMatrix, Ipopt::ScaledMatrix, Ipopt::SumMatrix, Ipopt::SumSymMatrix, Ipopt::SymScaledMatrix, Ipopt::TransposeMatrix, Ipopt::GenTMatrix, and Ipopt::SymTMatrix.

◆ ComputeColAMaxImpl()

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

protectedpure virtual

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.

Implemented in Ipopt::ZeroMatrix, Ipopt::ZeroSymMatrix, Ipopt::CompoundMatrix, Ipopt::DenseGenMatrix, Ipopt::ExpandedMultiVectorMatrix, Ipopt::ExpansionMatrix, Ipopt::LowRankUpdateSymMatrix, Ipopt::MultiVectorMatrix, Ipopt::ScaledMatrix, Ipopt::SumMatrix, Ipopt::SumSymMatrix, Ipopt::SymMatrix, Ipopt::GenTMatrix, and Ipopt::TransposeMatrix.

◆ PrintImpl()

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

protectedpure virtual

Print detailed information about the matrix.

Implemented in Ipopt::CompoundMatrix, Ipopt::CompoundSymMatrix, Ipopt::DenseGenMatrix, Ipopt::DenseSymMatrix, Ipopt::DiagMatrix, Ipopt::ExpandedMultiVectorMatrix, Ipopt::ExpansionMatrix, Ipopt::IdentityMatrix, Ipopt::LowRankUpdateSymMatrix, Ipopt::MultiVectorMatrix, Ipopt::ScaledMatrix, Ipopt::SumMatrix, Ipopt::SumSymMatrix, Ipopt::SymScaledMatrix, Ipopt::TransposeMatrix, Ipopt::ZeroMatrix, Ipopt::ZeroSymMatrix, Ipopt::GenTMatrix, and Ipopt::SymTMatrix.

◆ operator=()

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

private

Default Assignment Operator.

Member Data Documentation

◆ owner_space_

const SmartPtr<const MatrixSpace> Ipopt::Matrix::owner_space_

private

Definition at line 308 of file IpMatrix.hpp.

◆ valid_cache_tag_

TaggedObject::Tag Ipopt::Matrix::valid_cache_tag_

mutableprivate

Definition at line 312 of file IpMatrix.hpp.

◆ cached_valid_

bool Ipopt::Matrix::cached_valid_

mutableprivate

Definition at line 313 of file IpMatrix.hpp.

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

src/LinAlg/IpMatrix.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Matrix() [1/3]

◆ ~Matrix()

◆ Matrix() [2/3]

◆ Matrix() [3/3]

Member Function Documentation

◆ MultVector()

◆ TransMultVector()

◆ AddMSinvZ()

◆ SinvBlrmZMTdBr()

◆ HasValidNumbers()

◆ NRows()

◆ NCols()

◆ ComputeRowAMax()

◆ ComputeColAMax()

◆ Print() [1/2]

◆ Print() [2/2]

◆ OwnerSpace()

◆ MultVectorImpl()

◆ TransMultVectorImpl()

◆ AddMSinvZImpl()

◆ SinvBlrmZMTdBrImpl()

◆ HasValidNumbersImpl()

◆ ComputeRowAMaxImpl()

◆ ComputeColAMaxImpl()

◆ PrintImpl()

◆ operator=()

Member Data Documentation

◆ owner_space_

◆ valid_cache_tag_

◆ cached_valid_