Ipopt Documentation  
 
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Ipopt::SymScaledMatrixSpace Class Reference

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

#include <IpSymScaledMatrix.hpp>

+ Inheritance diagram for Ipopt::SymScaledMatrixSpace:

Public Member Functions

SymScaledMatrix * MakeNewSymScaledMatrix (bool allocate_unscaled_matrix=false) const
 Method for creating a new matrix of this specific type.
 
virtual SymMatrix * MakeNewSymMatrix () const
 Pure virtual method for creating a new matrix of this specific type.
 
virtual Matrix * MakeNew () const
 Pure virtual method for creating a new Matrix of the corresponding type.
 
SmartPtr< const Vector > RowColScaling () const
 return the vector for the row and column scaling
 
SmartPtr< const SymMatrixSpace > UnscaledMatrixSpace () const
 return the matrix space for the unscaled matrix
 
Constructors / Destructors
 SymScaledMatrixSpace (const SmartPtr< const Vector > &row_col_scaling, bool row_col_scaling_reciprocal, const SmartPtr< const SymMatrixSpace > &unscaled_matrix_space)
 Constructor, given the number of row and columns blocks, as well as the total number of rows and columns.
 
 ~SymScaledMatrixSpace ()
 Destructor.
 
- Public Member Functions inherited from Ipopt::SymMatrixSpace
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.

 SymScaledMatrixSpace ()
 Default constructor.
 
 SymScaledMatrixSpace (const SymScaledMatrixSpace &)
 Copy Constructor.
 
SymScaledMatrixSpace & operator= (const SymScaledMatrixSpace &)
 Default Assignment Operator.
 

Private Attributes

SmartPtr< Vector > scaling_
 Row scaling vector.
 
SmartPtr< const SymMatrixSpace > unscaled_matrix_space_
 unscaled matrix space
 

Detailed Description

This is the matrix space for SymScaledMatrix.

Definition at line 123 of file IpSymScaledMatrix.hpp.

Constructor & Destructor Documentation

◆ SymScaledMatrixSpace() [1/3]

Ipopt::SymScaledMatrixSpace::SymScaledMatrixSpace ( const SmartPtr< const Vector > &  row_col_scaling,
bool  row_col_scaling_reciprocal,
const SmartPtr< const SymMatrixSpace > &  unscaled_matrix_space 
)
inline

Constructor, given the number of row and columns blocks, as well as the total number of rows and columns.

Definition at line 131 of file IpSymScaledMatrix.hpp.

◆ ~SymScaledMatrixSpace()

Ipopt::SymScaledMatrixSpace::~SymScaledMatrixSpace ( )
inline

Destructor.

Definition at line 147 of file IpSymScaledMatrix.hpp.

◆ SymScaledMatrixSpace() [2/3]

Ipopt::SymScaledMatrixSpace::SymScaledMatrixSpace ( )
private

Default constructor.

◆ SymScaledMatrixSpace() [3/3]

Ipopt::SymScaledMatrixSpace::SymScaledMatrixSpace ( const SymScaledMatrixSpace &  )
private

Copy Constructor.

Member Function Documentation

◆ MakeNewSymScaledMatrix()

SymScaledMatrix * Ipopt::SymScaledMatrixSpace::MakeNewSymScaledMatrix ( bool  allocate_unscaled_matrix = false) const
inline

Method for creating a new matrix of this specific type.

Definition at line 152 of file IpSymScaledMatrix.hpp.

◆ MakeNewSymMatrix()

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

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

Implements Ipopt::SymMatrixSpace.

Definition at line 165 of file IpSymScaledMatrix.hpp.

◆ MakeNew()

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

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

Reimplemented from Ipopt::SymMatrixSpace.

Definition at line 170 of file IpSymScaledMatrix.hpp.

◆ RowColScaling()

SmartPtr< const Vector > Ipopt::SymScaledMatrixSpace::RowColScaling ( ) const
inline

return the vector for the row and column scaling

Definition at line 176 of file IpSymScaledMatrix.hpp.

◆ UnscaledMatrixSpace()

SmartPtr< const SymMatrixSpace > Ipopt::SymScaledMatrixSpace::UnscaledMatrixSpace ( ) const
inline

return the matrix space for the unscaled matrix

Definition at line 182 of file IpSymScaledMatrix.hpp.

◆ operator=()

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

Default Assignment Operator.

Member Data Documentation

◆ scaling_

SmartPtr<Vector> Ipopt::SymScaledMatrixSpace::scaling_
private

Row scaling vector.

Definition at line 212 of file IpSymScaledMatrix.hpp.

◆ unscaled_matrix_space_

SmartPtr<const SymMatrixSpace> Ipopt::SymScaledMatrixSpace::unscaled_matrix_space_
private

unscaled matrix space

Definition at line 215 of file IpSymScaledMatrix.hpp.

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