Class for Matrices which are multiples of the identity matrix. More...

#include <IpIdentityMatrix.hpp>

Inheritance diagram for Ipopt::IdentityMatrix:

Public Member Functions
void	SetFactor (Number factor)
	Method for setting the factor for the identity matrix.

Number	GetFactor () const
	Method for getting the factor for the identity matrix.

Index	Dim () const
	Method for obtaining the dimension of the matrix.

Constructors / Destructors
	IdentityMatrix (const SymMatrixSpace *owner_space)
	Constructor, initializing with dimensions of the matrix (true identity matrix).

	~IdentityMatrix ()
	Destructor.

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 void	AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = X + alpha*(Matrix S^{-1} Z).

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	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.
	IdentityMatrix ()
	Default Constructor.

	IdentityMatrix (const IdentityMatrix &)
	Copy Constructor.

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

Private Attributes
Number	factor_
	Scaling factor for this identity matrix.

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

Detailed Description

Class for Matrices which are multiples of the identity matrix.

Definition at line 17 of file IpIdentityMatrix.hpp.

Constructor & Destructor Documentation

◆ IdentityMatrix() [1/3]

Ipopt::IdentityMatrix::IdentityMatrix ( const SymMatrixSpace * owner_space )

Constructor, initializing with dimensions of the matrix (true identity matrix).

◆ ~IdentityMatrix()

Ipopt::IdentityMatrix::~IdentityMatrix ( )

Destructor.

◆ IdentityMatrix() [2/3]

Ipopt::IdentityMatrix::IdentityMatrix ( )

private

Default Constructor.

◆ IdentityMatrix() [3/3]

Ipopt::IdentityMatrix::IdentityMatrix ( const IdentityMatrix & )

private

Copy Constructor.

Member Function Documentation

◆ SetFactor()

void Ipopt::IdentityMatrix::SetFactor ( Number factor )

inline

Method for setting the factor for the identity matrix.

Definition at line 34 of file IpIdentityMatrix.hpp.

◆ GetFactor()

Number Ipopt::IdentityMatrix::GetFactor ( ) const

inline

Method for getting the factor for the identity matrix.

Definition at line 42 of file IpIdentityMatrix.hpp.

◆ Dim()

Index Ipopt::IdentityMatrix::Dim ( ) const

Method for obtaining the dimension of the matrix.

◆ MultVectorImpl()

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

◆ AddMSinvZImpl()

virtual void Ipopt::IdentityMatrix::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 from Ipopt::Matrix.

◆ HasValidNumbersImpl()

virtual bool Ipopt::IdentityMatrix::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::IdentityMatrix::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::IdentityMatrix::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::IdentityMatrix::operator= ( const IdentityMatrix & )

private

Default Assignment Operator.

Member Data Documentation

◆ factor_

Number Ipopt::IdentityMatrix::factor_

private

Scaling factor for this identity matrix.

Definition at line 109 of file IpIdentityMatrix.hpp.

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

src/LinAlg/IpIdentityMatrix.hpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IdentityMatrix() [1/3]

◆ ~IdentityMatrix()

◆ IdentityMatrix() [2/3]

◆ IdentityMatrix() [3/3]

Member Function Documentation

◆ SetFactor()

◆ GetFactor()

◆ Dim()

◆ MultVectorImpl()

◆ AddMSinvZImpl()

◆ HasValidNumbersImpl()

◆ ComputeRowAMaxImpl()

◆ PrintImpl()

◆ operator=()

Member Data Documentation

◆ factor_