Ipopt  3.12.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Private Attributes | List of all members
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:

Public Member Functions

void SetUnscaledMatrix (const SmartPtr< const Matrix > unscaled_matrix)
 Set the unscaled matrix. More...
 
void SetUnscaledMatrixNonConst (const SmartPtr< Matrix > &unscaled_matrix)
 Set the unscaled matrix in a non-const version. More...
 
SmartPtr< const MatrixGetUnscaledMatrix () const
 Return the unscaled matrix in const form. More...
 
SmartPtr< MatrixGetUnscaledMatrixNonConst ()
 Return the unscaled matrix in non-const form. More...
 
SmartPtr< const VectorRowScaling () const
 return the vector for the row scaling More...
 
SmartPtr< const VectorColumnScaling () const
 return the vector for the column scaling More...
 
Constructors / Destructors
 ScaledMatrix (const ScaledMatrixSpace *owner_space)
 Constructor, taking the owner_space. More...
 
 ~ScaledMatrix ()
 Destructor. More...
 
- 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). More...
 
SmartPtr< const MatrixSpaceOwnerSpace () const
 Return the owner MatrixSpace. More...
 
 Matrix (const MatrixSpace *owner_space)
 Constructor. More...
 
virtual ~Matrix ()
 Destructor. More...
 
void MultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix-vector multiply. More...
 
void TransMultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix(transpose) vector multiply. More...
 
void AddMSinvZ (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = X + alpha*(Matrix S^{-1} Z). More...
 
void 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). More...
 
Index NRows () const
 Number of rows. More...
 
Index NCols () const
 Number of columns. More...
 
void ComputeRowAMax (Vector &rows_norms, bool init=true) const
 Compute the max-norm of the rows in the matrix. More...
 
void ComputeColAMax (Vector &cols_norms, bool init=true) const
 Compute the max-norm of the columns in the matrix. More...
 
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. More...
 
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. More...
 
virtual ~TaggedObject ()
 Destructor. More...
 
Tag GetTag () const
 Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation. More...
 
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. More...
 
- 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. More...
 
virtual ~Subject ()
 Default destructor. More...
 
void AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
 Attach the specified observer (i.e., begin recieving notifications). More...
 
void DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
 Detach the specified observer (i.e., no longer recieve notifications). More...
 

Protected Member Functions

Methods overloaded from Matrix
virtual void MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix-vector multiply. More...
 
virtual void TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix(transpose) vector multiply. More...
 
virtual bool HasValidNumbersImpl () const
 Method for determining if all stored numbers are valid (i.e., no Inf or Nan). More...
 
virtual void ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
 Compute the max-norm of the rows in the matrix. More...
 
virtual void ComputeColAMaxImpl (Vector &cols_norms, bool init) const
 Compute the max-norm of the columns in the matrix. More...
 
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. More...
 
virtual void AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = beta*X + alpha*(Matrix S^{-1} Z). More...
 
virtual void SinvBlrmZMTdBrImpl (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). More...
 
implementation methods (derived classes MUST

overload these pure virtual protected methods.

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

 ScaledMatrix ()
 Default Constructor. More...
 
 ScaledMatrix (const ScaledMatrix &)
 Copy Constructor. More...
 
void operator= (const ScaledMatrix &)
 Overloaded Equals Operator. More...
 

Private Attributes

SmartPtr< const Matrixmatrix_
 const version of the unscaled matrix More...
 
SmartPtr< Matrixnonconst_matrix_
 non-const version of the unscaled matrix More...
 
SmartPtr< const ScaledMatrixSpaceowner_space_
 Matrix space stored as a ScaledMatrixSpace. More...
 

Additional Inherited Members

- Public Types inherited from Ipopt::TaggedObject
typedef unsigned int Tag
 Type for the Tag values. More...
 

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 211 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 219 of file IpScaledMatrix.hpp.

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

Return the unscaled matrix in const form.

Definition at line 227 of file IpScaledMatrix.hpp.

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

Return the unscaled matrix in non-const form.

Definition at line 233 of file IpScaledMatrix.hpp.

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

return the vector for the row scaling

Definition at line 241 of file IpScaledMatrix.hpp.

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

return the vector for the column scaling

Definition at line 247 of file IpScaledMatrix.hpp.

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

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

virtual bool Ipopt::ScaledMatrix::HasValidNumbersImpl ( ) const
protectedvirtual

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

Implements Ipopt::Matrix.

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

Implements 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
protectedvirtual

Print detailed information about the matrix.

Implements Ipopt::Matrix.

virtual void Ipopt::ScaledMatrix::AddMSinvZImpl ( Number  alpha,
const Vector S,
const Vector Z,
Vector X 
) const
protectedvirtual

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
protectedvirtual

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

Specialized implementation missing so far!

Reimplemented from Ipopt::Matrix.

void Ipopt::ScaledMatrix::operator= ( const ScaledMatrix )
private

Overloaded Equals Operator.

Member Data Documentation

SmartPtr<const Matrix> Ipopt::ScaledMatrix::matrix_
private

const version of the unscaled matrix

Definition at line 118 of file IpScaledMatrix.hpp.

SmartPtr<Matrix> Ipopt::ScaledMatrix::nonconst_matrix_
private

non-const version of the unscaled matrix

Definition at line 120 of file IpScaledMatrix.hpp.

SmartPtr<const ScaledMatrixSpace> Ipopt::ScaledMatrix::owner_space_
private

Matrix space stored as a ScaledMatrixSpace.

Definition at line 123 of file IpScaledMatrix.hpp.


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