Ipopt::ScaledMatrix Class Reference

Class for a Matrix in conjunction with its scaling factors for row and column scaling. More...

#include <IpScaledMatrix.hpp>

Inheritance diagram for Ipopt::ScaledMatrix:

[legend]

Collaboration diagram for Ipopt::ScaledMatrix:

[legend]

List of all members.

Public Member Functions
void	SetUnscaledMatrix (const SmartPtr< const Matrix > unscaled_matrix)
	Set the unscaled matrix.
void	SetUnscaledMatrixNonConst (const SmartPtr< Matrix > &unscaled_matrix)
	Set the unscaled matrix in a non-const version.
SmartPtr< const Matrix >	GetUnscaledMatrix () const
	Return the unscaled matrix in const form.
SmartPtr< Matrix >	GetUnscaledMatrixNonConst ()
	Return the unscaled matrix in non-const form.
SmartPtr< const Vector >	RowScaling () const
	return the vector for the row scaling
SmartPtr< const Vector >	ColumnScaling () const
	return the vector for the column scaling
Constructors / Destructors

	ScaledMatrix (const ScaledMatrixSpace *owner_space)
	Constructor, taking the owner_space.
	~ScaledMatrix ()
	Destructor.
Protected Member Functions
Methods overloaded from Matrix

virtual void	MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
virtual void	TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
virtual bool	HasValidNumbersImpl () const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
virtual void	PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
	Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
virtual void	AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
	X = betaX + 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).
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.
	ScaledMatrix ()
	Default Constructor.
	ScaledMatrix (const ScaledMatrix &)
	Copy Constructor.
void	operator= (const ScaledMatrix &)
	Overloaded Equals Operator.
Private Attributes
SmartPtr< const Matrix >	matrix_
	const version of the unscaled matrix
SmartPtr< Matrix >	nonconst_matrix_
	non-const version of the unscaled matrix
SmartPtr< const ScaledMatrixSpace >	owner_space_
	Matrix space stored as a ScaledMatrixSpace.

Detailed Description

Class for a Matrix in conjunction with its scaling factors for row and column scaling.

Operations on the matrix are performed using the scaled matrix. You can pull out the pointer to the unscaled matrix for unscaled calculations.

Definition at line 26 of file IpScaledMatrix.hpp.

Constructor & Destructor Documentation

Ipopt::ScaledMatrix::ScaledMatrix ( const ScaledMatrixSpace * owner_space )

Constructor, taking the owner_space.

Ipopt::ScaledMatrix::~ScaledMatrix ( )

Destructor.

Ipopt::ScaledMatrix::ScaledMatrix ( ) [private]

Default Constructor.

Ipopt::ScaledMatrix::ScaledMatrix ( const ScaledMatrix & ) [private]

Copy Constructor.

Member Function Documentation

void Ipopt::ScaledMatrix::SetUnscaledMatrix ( const SmartPtr< const Matrix > unscaled_matrix ) [inline]

Set the unscaled matrix.

Definition at line 207 of file IpScaledMatrix.hpp.

void Ipopt::ScaledMatrix::SetUnscaledMatrixNonConst ( const SmartPtr< Matrix > & unscaled_matrix ) [inline]

Set the unscaled matrix in a non-const version.

Definition at line 215 of file IpScaledMatrix.hpp.

SmartPtr< const Matrix > Ipopt::ScaledMatrix::GetUnscaledMatrix ( ) const [inline]

Return the unscaled matrix in const form.

Definition at line 223 of file IpScaledMatrix.hpp.

SmartPtr< Matrix > Ipopt::ScaledMatrix::GetUnscaledMatrixNonConst ( ) [inline]

Return the unscaled matrix in non-const form.

Definition at line 229 of file IpScaledMatrix.hpp.

SmartPtr< const Vector > Ipopt::ScaledMatrix::RowScaling ( ) const [inline]

return the vector for the row scaling

Definition at line 237 of file IpScaledMatrix.hpp.

SmartPtr< const Vector > Ipopt::ScaledMatrix::ColumnScaling ( ) const [inline]

return the vector for the column scaling

Definition at line 243 of file IpScaledMatrix.hpp.

virtual void Ipopt::ScaledMatrix::MultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)			const `[protected, virtual]`

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

It is assumed that the scaling factors are valid.

Implements Ipopt::Matrix.

virtual void Ipopt::ScaledMatrix::TransMultVectorImpl	(	Number	alpha,
		const Vector &	x,
		Number	beta,
		Vector &	y
	)			const `[protected, virtual]`

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

It is assumed that the scaling factors are valid.

Implements Ipopt::Matrix.

virtual bool Ipopt::ScaledMatrix::HasValidNumbersImpl ( ) const [protected, virtual]

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

It is assumed that the scaling factors are valid.

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::ScaledMatrix::PrintImpl	(	const Journalist &	jnlst,
		EJournalLevel	level,
		EJournalCategory	category,
		const std::string &	name,
		Index	indent,
		const std::string &	prefix
	)			const `[protected, virtual]`

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

It is assumed that the scaling factors are valid.

Implements Ipopt::Matrix.

virtual void Ipopt::ScaledMatrix::AddMSinvZImpl	(	Number	alpha,
		const Vector &	S,
		const Vector &	Z,
		Vector &	X
	)			const `[protected, virtual]`

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

Specialized implementation missing so far!

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::ScaledMatrix::SinvBlrmZMTdBrImpl	(	Number	alpha,
		const Vector &	S,
		const Vector &	R,
		const Vector &	Z,
		const Vector &	D,
		Vector &	X
	)			const `[protected, virtual]`