IdentityMatrix Class Reference
#include <IpIdentityMatrix.hpp>
Detailed Description
Class for Matrices which are multiples of the identity matrix.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 dimention of the matrix. | |
Constructors / Destructors | |
| IdentityMatrix (const SymMatrixSpace *owner_space) | |
| Constructor, initializing with dimensions of the matrix (true identity matrix). | |
| ~IdentityMatrix () | |
| 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 | AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) 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). | |
Constructor & Destructor Documentation
| IdentityMatrix | ( | const SymMatrixSpace * | owner_space | ) |
Constructor, initializing with dimensions of the matrix (true identity matrix).
| ~IdentityMatrix | ( | ) |
Destructor.
Member Function Documentation
| void SetFactor | ( | Number | factor | ) | [inline] |
Method for setting the factor for the identity matrix.
Referenced by RestoIpoptNLP::jac_c(), and RestoIpoptNLP::jac_d().
| Number GetFactor | ( | ) | const [inline] |
Method for getting the factor for the identity matrix.
| Index Dim | ( | ) | const |
Method for obtaining the dimention of the matrix.
Reimplemented from SymMatrix.
References DBG_ASSERT, Matrix::NCols(), and Matrix::NRows().
Referenced by TripletHelper::GetNumberEntries().
| void 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).
Implements Matrix.
References Vector::AddOneVector(), DBG_ASSERT, Vector::Dim(), Matrix::NCols(), and Matrix::NRows().
| void AddMSinvZImpl | ( | Number | alpha, | |
| const Vector & | S, | |||
| const Vector & | Z, | |||
| Vector & | X | |||
| ) | const [protected, virtual] |
Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
Reimplemented from Matrix.
References Vector::AddVectorQuotient(), DBG_ASSERT, Vector::Dim(), Matrix::NCols(), and Matrix::NRows().
| bool HasValidNumbersImpl | ( | ) | const [protected, virtual] |
Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
Reimplemented from Matrix.
References Ipopt::IsFiniteNumber().
| void 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).
Implements Matrix.
References DBG_ASSERT, Matrix::NCols(), Matrix::NRows(), Journalist::Printf(), and Journalist::PrintfIndented().
The documentation for this class was generated from the following files:
