Ipopt Documentation  
 
Loading...
Searching...
No Matches
Ipopt::SymMatrixSpace Class Referenceabstract

SymMatrixSpace base class, corresponding to the SymMatrix base class. More...

#include <IpSymMatrix.hpp>

+ Inheritance diagram for Ipopt::SymMatrixSpace:

Public Member Functions

virtual SymMatrixMakeNewSymMatrix () const =0
 Pure virtual method for creating a new matrix of this specific type.
 
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.
 
Constructors/Destructors
 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.

 SymMatrixSpace ()
 Default constructor.
 
 SymMatrixSpace (const SymMatrixSpace &)
 
SymMatrixSpaceoperator= (const SymMatrixSpace &)
 Default Assignment Operator.
 

Detailed Description

SymMatrixSpace base class, corresponding to the SymMatrix base class.

Definition at line 85 of file IpSymMatrix.hpp.

Constructor & Destructor Documentation

◆ SymMatrixSpace() [1/3]

Ipopt::SymMatrixSpace::SymMatrixSpace ( Index  dim)
inline

Constructor, given the dimension (identical to the number of rows and columns).

Definition at line 93 of file IpSymMatrix.hpp.

◆ ~SymMatrixSpace()

virtual Ipopt::SymMatrixSpace::~SymMatrixSpace ( )
inlinevirtual

Destructor.

Definition at line 100 of file IpSymMatrix.hpp.

◆ SymMatrixSpace() [2/3]

Ipopt::SymMatrixSpace::SymMatrixSpace ( )
private

Default constructor.

◆ SymMatrixSpace() [3/3]

Ipopt::SymMatrixSpace::SymMatrixSpace ( const SymMatrixSpace )
private

Member Function Documentation

◆ MakeNewSymMatrix()

virtual SymMatrix * Ipopt::SymMatrixSpace::MakeNewSymMatrix ( ) const
pure virtual

◆ MakeNew()

virtual Matrix * Ipopt::SymMatrixSpace::MakeNew ( ) const
inlinevirtual

Pure virtual method for creating a new Matrix of the corresponding type.

Implements Ipopt::MatrixSpace.

Reimplemented in Ipopt::SymScaledMatrixSpace, and Ipopt::ZeroSymMatrixSpace.

Definition at line 107 of file IpSymMatrix.hpp.

◆ Dim()

Index Ipopt::SymMatrixSpace::Dim ( ) const
inline

Accessor method for the dimension of the matrices in this matrix space.

Definition at line 115 of file IpSymMatrix.hpp.

◆ operator=()

SymMatrixSpace & Ipopt::SymMatrixSpace::operator= ( const SymMatrixSpace )
private

Default Assignment Operator.


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