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

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

#include <IpScaledMatrix.hpp>

+ Inheritance diagram for Ipopt::ScaledMatrixSpace:

Public Member Functions

ScaledMatrixMakeNewScaledMatrix (bool allocate_unscaled_matrix=false) const
 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.
 
SmartPtr< const VectorRowScaling () const
 return the vector for the row scaling
 
SmartPtr< const MatrixSpaceUnscaledMatrixSpace () const
 return the matrix space for the unscaled matrix
 
SmartPtr< const VectorColumnScaling () const
 return the vector for the column scaling
 
Constructors / Destructors
 ScaledMatrixSpace (const SmartPtr< const Vector > &row_scaling, bool row_scaling_reciprocal, const SmartPtr< const MatrixSpace > &unscaled_matrix_space, const SmartPtr< const Vector > &column_scaling, bool column_scaling_reciprocal)
 Constructor, given the number of row and columns blocks, as well as the totel number of rows and columns.
 
 ~ScaledMatrixSpace ()
 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.

 ScaledMatrixSpace ()
 Default constructor.
 
 ScaledMatrixSpace (const ScaledMatrixSpace &)
 Copy Constructor.
 
ScaledMatrixSpaceoperator= (const ScaledMatrixSpace &)
 Default Assignment Operator.
 

Private Attributes

SmartPtr< Vectorrow_scaling_
 Row scaling vector.
 
SmartPtr< const MatrixSpaceunscaled_matrix_space_
 unscaled matrix space
 
SmartPtr< Vectorcolumn_scaling_
 column scaling vector
 

Detailed Description

This is the matrix space for ScaledMatrix.

Definition at line 157 of file IpScaledMatrix.hpp.

Constructor & Destructor Documentation

◆ ScaledMatrixSpace() [1/3]

Ipopt::ScaledMatrixSpace::ScaledMatrixSpace ( const SmartPtr< const Vector > &  row_scaling,
bool  row_scaling_reciprocal,
const SmartPtr< const MatrixSpace > &  unscaled_matrix_space,
const SmartPtr< const Vector > &  column_scaling,
bool  column_scaling_reciprocal 
)

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

◆ ~ScaledMatrixSpace()

Ipopt::ScaledMatrixSpace::~ScaledMatrixSpace ( )
inline

Destructor.

Definition at line 174 of file IpScaledMatrix.hpp.

◆ ScaledMatrixSpace() [2/3]

Ipopt::ScaledMatrixSpace::ScaledMatrixSpace ( )
private

Default constructor.

◆ ScaledMatrixSpace() [3/3]

Ipopt::ScaledMatrixSpace::ScaledMatrixSpace ( const ScaledMatrixSpace )
private

Copy Constructor.

Member Function Documentation

◆ MakeNewScaledMatrix()

ScaledMatrix * Ipopt::ScaledMatrixSpace::MakeNewScaledMatrix ( bool  allocate_unscaled_matrix = false) const
inline

Method for creating a new matrix of this specific type.

Definition at line 179 of file IpScaledMatrix.hpp.

◆ MakeNew()

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

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

Implements Ipopt::MatrixSpace.

Definition at line 192 of file IpScaledMatrix.hpp.

◆ RowScaling()

SmartPtr< const Vector > Ipopt::ScaledMatrixSpace::RowScaling ( ) const
inline

return the vector for the row scaling

Definition at line 198 of file IpScaledMatrix.hpp.

◆ UnscaledMatrixSpace()

SmartPtr< const MatrixSpace > Ipopt::ScaledMatrixSpace::UnscaledMatrixSpace ( ) const
inline

return the matrix space for the unscaled matrix

Definition at line 204 of file IpScaledMatrix.hpp.

◆ ColumnScaling()

SmartPtr< const Vector > Ipopt::ScaledMatrixSpace::ColumnScaling ( ) const
inline

return the vector for the column scaling

Definition at line 210 of file IpScaledMatrix.hpp.

◆ operator=()

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

Default Assignment Operator.

Member Data Documentation

◆ row_scaling_

SmartPtr<Vector> Ipopt::ScaledMatrixSpace::row_scaling_
private

Row scaling vector.

Definition at line 240 of file IpScaledMatrix.hpp.

◆ unscaled_matrix_space_

SmartPtr<const MatrixSpace> Ipopt::ScaledMatrixSpace::unscaled_matrix_space_
private

unscaled matrix space

Definition at line 243 of file IpScaledMatrix.hpp.

◆ column_scaling_

SmartPtr<Vector> Ipopt::ScaledMatrixSpace::column_scaling_
private

column scaling vector

Definition at line 246 of file IpScaledMatrix.hpp.


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