Ipopt Documentation  
 
Loading...
Searching...
No Matches
Ipopt::LowRankUpdateSymMatrixSpace Class Reference

This is the matrix space for LowRankUpdateSymMatrix. More...

#include <IpLowRankUpdateSymMatrix.hpp>

+ Inheritance diagram for Ipopt::LowRankUpdateSymMatrixSpace:

Public Member Functions

virtual SymMatrixMakeNewSymMatrix () const
 Pure virtual method for creating a new matrix of this specific type.
 
LowRankUpdateSymMatrixMakeNewLowRankUpdateSymMatrix () const
 Method for creating a new matrix of this specific type.
 
SmartPtr< const MatrixP_LowRank () const
 
SmartPtr< const VectorSpaceLowRankVectorSpace () const
 
bool ReducedDiag () const
 
Constructors / Destructors
 LowRankUpdateSymMatrixSpace (Index dim, SmartPtr< const Matrix > P_LowRank, SmartPtr< const VectorSpace > LowRankVectorSpace, bool reduced_diag)
 Constructor, given the dimension of the matrix.
 
virtual ~LowRankUpdateSymMatrixSpace ()
 Destructor.
 
- Public Member Functions inherited from Ipopt::SymMatrixSpace
virtual MatrixMakeNew () const
 Pure virtual method for creating a new Matrix of the corresponding type.
 
Index Dim () const
 Accessor method for the dimension of the matrices in this matrix space.
 
 SymMatrixSpace (Index dim)
 Constructor, given the dimension (identical to the number of rows and columns).
 
virtual ~SymMatrixSpace ()
 Destructor.
 
- Public Member Functions inherited from Ipopt::MatrixSpace
Index NRows () const
 Accessor function for the number of rows.
 
Index NCols () const
 Accessor function for the number of columns.
 
bool IsMatrixFromSpace (const Matrix &matrix) const
 Method to test if a given matrix belongs to a particular matrix space.
 
 MatrixSpace (Index nRows, Index nCols)
 Constructor, given the number rows and columns of all matrices generated by this MatrixSpace.
 
virtual ~MatrixSpace ()
 Destructor.
 
- 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
 

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.

 LowRankUpdateSymMatrixSpace ()
 Default Constructor.
 
 LowRankUpdateSymMatrixSpace (const LowRankUpdateSymMatrixSpace &)
 Copy Constructor.
 
void operator= (const LowRankUpdateSymMatrixSpace &)
 Default Assignment Operator.
 

Private Attributes

SmartPtr< const MatrixP_LowRank_
 Expansion matrix to lift the low-rank approximation into a possibly higher-dimensional space.
 
SmartPtr< const VectorSpacelowrank_vector_space_
 Vector space for the space in which the low-rank approximation lives.
 
bool reduced_diag_
 Flag indicating whether the diagonal matrix is nonzero only in the space of V or in the full space.
 

Detailed Description

This is the matrix space for LowRankUpdateSymMatrix.

Definition at line 173 of file IpLowRankUpdateSymMatrix.hpp.

Constructor & Destructor Documentation

◆ LowRankUpdateSymMatrixSpace() [1/3]

Ipopt::LowRankUpdateSymMatrixSpace::LowRankUpdateSymMatrixSpace ( Index  dim,
SmartPtr< const Matrix P_LowRank,
SmartPtr< const VectorSpace LowRankVectorSpace,
bool  reduced_diag 
)
inline

Constructor, given the dimension of the matrix.

Definition at line 179 of file IpLowRankUpdateSymMatrix.hpp.

◆ ~LowRankUpdateSymMatrixSpace()

virtual Ipopt::LowRankUpdateSymMatrixSpace::~LowRankUpdateSymMatrixSpace ( )
inlinevirtual

Destructor.

Definition at line 194 of file IpLowRankUpdateSymMatrix.hpp.

◆ LowRankUpdateSymMatrixSpace() [2/3]

Ipopt::LowRankUpdateSymMatrixSpace::LowRankUpdateSymMatrixSpace ( )
private

Default Constructor.

◆ LowRankUpdateSymMatrixSpace() [3/3]

Ipopt::LowRankUpdateSymMatrixSpace::LowRankUpdateSymMatrixSpace ( const LowRankUpdateSymMatrixSpace )
private

Copy Constructor.

Member Function Documentation

◆ MakeNewSymMatrix()

virtual SymMatrix * Ipopt::LowRankUpdateSymMatrixSpace::MakeNewSymMatrix ( ) const
inlinevirtual

Pure virtual method for creating a new matrix of this specific type.

Implements Ipopt::SymMatrixSpace.

Definition at line 198 of file IpLowRankUpdateSymMatrix.hpp.

◆ MakeNewLowRankUpdateSymMatrix()

LowRankUpdateSymMatrix * Ipopt::LowRankUpdateSymMatrixSpace::MakeNewLowRankUpdateSymMatrix ( ) const
inline

Method for creating a new matrix of this specific type.

Definition at line 204 of file IpLowRankUpdateSymMatrix.hpp.

◆ P_LowRank()

SmartPtr< const Matrix > Ipopt::LowRankUpdateSymMatrixSpace::P_LowRank ( ) const
inline

Definition at line 209 of file IpLowRankUpdateSymMatrix.hpp.

◆ LowRankVectorSpace()

SmartPtr< const VectorSpace > Ipopt::LowRankUpdateSymMatrixSpace::LowRankVectorSpace ( ) const
inline

Definition at line 214 of file IpLowRankUpdateSymMatrix.hpp.

◆ ReducedDiag()

bool Ipopt::LowRankUpdateSymMatrixSpace::ReducedDiag ( ) const
inline

Definition at line 219 of file IpLowRankUpdateSymMatrix.hpp.

◆ operator=()

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

Default Assignment Operator.

Member Data Documentation

◆ P_LowRank_

SmartPtr<const Matrix> Ipopt::LowRankUpdateSymMatrixSpace::P_LowRank_
private

Expansion matrix to lift the low-rank approximation into a possibly higher-dimensional space.

If it is NULL, it is assume that no lift is performed.

Definition at line 253 of file IpLowRankUpdateSymMatrix.hpp.

◆ lowrank_vector_space_

SmartPtr<const VectorSpace> Ipopt::LowRankUpdateSymMatrixSpace::lowrank_vector_space_
private

Vector space for the space in which the low-rank approximation lives.

Definition at line 256 of file IpLowRankUpdateSymMatrix.hpp.

◆ reduced_diag_

bool Ipopt::LowRankUpdateSymMatrixSpace::reduced_diag_
private

Flag indicating whether the diagonal matrix is nonzero only in the space of V or in the full space.

Definition at line 261 of file IpLowRankUpdateSymMatrix.hpp.


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