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::IdentityMatrix Class Reference

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. More...
 
Number GetFactor () const
 Method for getting the factor for the identity matrix. More...
 
Index Dim () const
 Method for obtaining the dimention of the matrix. More...
 
Constructors / Destructors
 IdentityMatrix (const SymMatrixSpace *owner_space)
 Constructor, initializing with dimensions of the matrix (true identity matrix). More...
 
 ~IdentityMatrix ()
 Destructor. More...
 
- Public Member Functions inherited from Ipopt::SymMatrix
SmartPtr< const SymMatrixSpaceOwnerSymMatrixSpace () const
 
 SymMatrix (const SymMatrixSpace *owner_space)
 Constructor, taking the owner_space. More...
 
virtual ~SymMatrix ()
 Destructor. More...
 
Index Dim () const
 Dimension of the matrix (number of rows and columns) 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 AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = X + alpha*(Matrix S^{-1} Z). 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 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...
 
- Protected Member Functions inherited from Ipopt::SymMatrix
virtual void TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Since the matrix is symmetric, it is only necessary to implement the MultVectorImpl method in a class that inherits from this base class. More...
 
virtual void ComputeColAMaxImpl (Vector &cols_norms, bool init) const
 Since the matrix is symmetric, the row and column max norms are identical. More...
 
- 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 + alpha*Z*M^Td). More...
 
- 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.

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

Private Attributes

Number factor_
 Scaling factor for this identity matrix. More...
 

Additional Inherited Members

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

Detailed Description

Class for Matrices which are multiples of the identity matrix.

Definition at line 21 of file IpIdentityMatrix.hpp.

Constructor & Destructor Documentation

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

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

Ipopt::IdentityMatrix::~IdentityMatrix ( )

Destructor.

Ipopt::IdentityMatrix::IdentityMatrix ( )
private

Default Constructor.

Ipopt::IdentityMatrix::IdentityMatrix ( const IdentityMatrix )
private

Copy Constructor.

Member Function Documentation

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

Method for setting the factor for the identity matrix.

Definition at line 38 of file IpIdentityMatrix.hpp.

Number Ipopt::IdentityMatrix::GetFactor ( ) const
inline

Method for getting the factor for the identity matrix.

Definition at line 44 of file IpIdentityMatrix.hpp.

Index Ipopt::IdentityMatrix::Dim ( ) const

Method for obtaining the dimention of the matrix.

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.

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.

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

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

Reimplemented from Ipopt::Matrix.

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.

Implements Ipopt::Matrix.

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.

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

Overloaded Equals Operator.

Member Data Documentation

Number Ipopt::IdentityMatrix::factor_
private

Scaling factor for this identity matrix.

Definition at line 95 of file IpIdentityMatrix.hpp.


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