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

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

#include <IpDiagMatrix.hpp>

+ Inheritance diagram for Ipopt::DiagMatrixSpace:

Public Member Functions

virtual SymMatrixMakeNewSymMatrix () const
 Pure virtual method for creating a new matrix of this specific type.
 
DiagMatrixMakeNewDiagMatrix () const
 Method for creating a new matrix of this specific type.
 
Constructors / Destructors
 DiagMatrixSpace (Index dim)
 Constructor, given the dimension of the matrix.
 
virtual ~DiagMatrixSpace ()
 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.

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

Detailed Description

This is the matrix space for DiagMatrix.

Definition at line 104 of file IpDiagMatrix.hpp.

Constructor & Destructor Documentation

◆ DiagMatrixSpace() [1/3]

Ipopt::DiagMatrixSpace::DiagMatrixSpace ( Index  dim)
inline

Constructor, given the dimension of the matrix.

Definition at line 110 of file IpDiagMatrix.hpp.

◆ ~DiagMatrixSpace()

virtual Ipopt::DiagMatrixSpace::~DiagMatrixSpace ( )
inlinevirtual

Destructor.

Definition at line 117 of file IpDiagMatrix.hpp.

◆ DiagMatrixSpace() [2/3]

Ipopt::DiagMatrixSpace::DiagMatrixSpace ( )
private

Default Constructor.

◆ DiagMatrixSpace() [3/3]

Ipopt::DiagMatrixSpace::DiagMatrixSpace ( const DiagMatrixSpace )
private

Copy Constructor.

Member Function Documentation

◆ MakeNewSymMatrix()

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

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

Implements Ipopt::SymMatrixSpace.

Definition at line 121 of file IpDiagMatrix.hpp.

◆ MakeNewDiagMatrix()

DiagMatrix * Ipopt::DiagMatrixSpace::MakeNewDiagMatrix ( ) const
inline

Method for creating a new matrix of this specific type.

Definition at line 127 of file IpDiagMatrix.hpp.

◆ operator=()

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

Default Assignment Operator.


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