Ipopt  3.12.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Protected Member Functions | Private Attributes | Friends | List of all members
Ipopt::GenTMatrix Class Reference

Class for general matrices stored in triplet format. More...

#include <IpGenTMatrix.hpp>

+ Inheritance diagram for Ipopt::GenTMatrix:

Public Member Functions

Constructors / Destructors
 GenTMatrix (const GenTMatrixSpace *owner_space)
 Constructor, taking the owner_space. More...
 
 ~GenTMatrix ()
 Destructor. More...
 
Changing the Values.
void SetValues (const Number *Values)
 Set values of nonzero elements. More...
 
Accessor Methods
Index Nonzeros () const
 Number of nonzero entries. More...
 
const IndexIrows () const
 Array with Row indices (counting starts at 1) More...
 
const IndexJcols () const
 Array with Column indices (counting starts at 1) More...
 
const NumberValues () const
 Array with nonzero values (const version). More...
 
NumberValues ()
 Array with the nonzero values of this matrix (non-const version). More...
 
- Public Member Functions inherited from Ipopt::Matrix
bool HasValidNumbers () const
 Method for determining if all stored numbers are valid (i.e., no Inf or Nan). More...
 
SmartPtr< const MatrixSpaceOwnerSpace () const
 Return the owner MatrixSpace. More...
 
 Matrix (const MatrixSpace *owner_space)
 Constructor. More...
 
virtual ~Matrix ()
 Destructor. More...
 
void MultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix-vector multiply. More...
 
void TransMultVector (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix(transpose) vector multiply. More...
 
void AddMSinvZ (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = X + alpha*(Matrix S^{-1} Z). More...
 
void SinvBlrmZMTdBr (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
 X = S^{-1} (r + alpha*Z*M^Td). More...
 
Index NRows () const
 Number of rows. More...
 
Index NCols () const
 Number of columns. More...
 
void ComputeRowAMax (Vector &rows_norms, bool init=true) const
 Compute the max-norm of the rows in the matrix. More...
 
void ComputeColAMax (Vector &cols_norms, bool init=true) const
 Compute the max-norm of the columns in the matrix. More...
 
virtual void Print (SmartPtr< const Journalist > jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const
 Print detailed information about the matrix. More...
 
virtual void Print (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent=0, const std::string &prefix="") const
 
- Public Member Functions inherited from Ipopt::TaggedObject
 TaggedObject ()
 Constructor. More...
 
virtual ~TaggedObject ()
 Destructor. More...
 
Tag GetTag () const
 Users of TaggedObjects call this to update their own internal tags every time they perform the expensive operation. More...
 
bool HasChanged (const Tag comparison_tag) const
 Users of TaggedObjects call this to check if the object HasChanged since they last updated their own internal tag. More...
 
- 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
 
- Public Member Functions inherited from Ipopt::Subject
 Subject ()
 Default Constructor. More...
 
virtual ~Subject ()
 Default destructor. More...
 
void AttachObserver (Observer::NotifyType notify_type, Observer *observer) const
 Attach the specified observer (i.e., begin recieving notifications). More...
 
void DetachObserver (Observer::NotifyType notify_type, Observer *observer) const
 Detach the specified observer (i.e., no longer recieve notifications). More...
 

Protected Member Functions

void PrintImplOffset (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix, Index offset) const
 
Overloaded methods from Matrix base class
virtual void MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix-vector multiply. More...
 
virtual void TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
 Matrix(transpose) vector multiply. More...
 
virtual bool HasValidNumbersImpl () const
 Method for determining if all stored numbers are valid (i.e., no Inf or Nan). More...
 
virtual void ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
 Compute the max-norm of the rows in the matrix. More...
 
virtual void ComputeColAMaxImpl (Vector &cols_norms, bool init) const
 Compute the max-norm of the columns in the matrix. More...
 
virtual void PrintImpl (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix) const
 Print detailed information about the matrix. More...
 
- Protected Member Functions inherited from Ipopt::Matrix
virtual void AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
 X = X + alpha*(Matrix S^{-1} Z). More...
 
virtual void SinvBlrmZMTdBrImpl (Number alpha, const Vector &S, const Vector &R, const Vector &Z, const Vector &D, Vector &X) const
 X = S^{-1} (r + alpha*Z*M^Td). More...
 
- Protected Member Functions inherited from Ipopt::TaggedObject
void ObjectChanged ()
 Objects derived from TaggedObject MUST call this method every time their internal state changes to update the internal tag for comparison. More...
 
- Protected Member Functions inherited from Ipopt::Subject
void Notify (Observer::NotifyType notify_type) 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.

 GenTMatrix ()
 Default Constructor. More...
 
 GenTMatrix (const GenTMatrix &)
 Copy Constructor. More...
 
void operator= (const GenTMatrix &)
 Overloaded Equals Operator. More...
 

Private Attributes

const GenTMatrixSpaceowner_space_
 Copy of the owner space as a GenTMatrixSpace instead of a MatrixSpace. More...
 
Numbervalues_
 Values of nonzeros. More...
 
bool initialized_
 Flag for Initialization. More...
 

Friends

class ParGenMatrix
 

Additional Inherited Members

- Public Types inherited from Ipopt::TaggedObject
typedef unsigned int Tag
 Type for the Tag values. More...
 

Detailed Description

Class for general matrices stored in triplet format.

In the triplet format, the nonzeros elements of a general matrix is stored in three arrays, Irow, Jcol, and Values, all of length Nonzeros. The first two arrays indicate the location of a non-zero element (row and column indices), and the last array stores the value at that location. If nonzero elements are listed more than once, their values are added.

The structure of the nonzeros (i.e. the arrays Irow and Jcol) cannot be changed after the matrix can been initialized. Only the values of the nonzero elements can be modified.

Note that the first row and column of a matrix has index 1, not 0.

Definition at line 36 of file IpGenTMatrix.hpp.

Constructor & Destructor Documentation

Ipopt::GenTMatrix::GenTMatrix ( const GenTMatrixSpace owner_space)

Constructor, taking the owner_space.

Ipopt::GenTMatrix::~GenTMatrix ( )

Destructor.

Ipopt::GenTMatrix::GenTMatrix ( )
private

Default Constructor.

Ipopt::GenTMatrix::GenTMatrix ( const GenTMatrix )
private

Copy Constructor.

Member Function Documentation

void Ipopt::GenTMatrix::SetValues ( const Number Values)

Set values of nonzero elements.

The values of the nonzero elements are copied from the incoming Number array. Important: It is assume that the order of the values in Values corresponds to the one of Irn and Jcn given to one of the constructors above.

Index Ipopt::GenTMatrix::Nonzeros ( ) const
inline

Number of nonzero entries.

Definition at line 245 of file IpGenTMatrix.hpp.

const Index * Ipopt::GenTMatrix::Irows ( ) const
inline

Array with Row indices (counting starts at 1)

Definition at line 251 of file IpGenTMatrix.hpp.

const Index * Ipopt::GenTMatrix::Jcols ( ) const
inline

Array with Column indices (counting starts at 1)

Definition at line 257 of file IpGenTMatrix.hpp.

const Number* Ipopt::GenTMatrix::Values ( ) const
inline

Array with nonzero values (const version).

Definition at line 73 of file IpGenTMatrix.hpp.

Number* Ipopt::GenTMatrix::Values ( )
inline

Array with the nonzero values of this matrix (non-const version).

Use this method only if you are intending to change the values, because the GenTMatrix will be marked as changed.

Definition at line 82 of file IpGenTMatrix.hpp.

virtual void Ipopt::GenTMatrix::MultVectorImpl ( Number  alpha,
const Vector x,
Number  beta,
Vector y 
) const
protectedvirtual

Matrix-vector multiply.

Computes y = alpha * Matrix * x + beta * y

Implements Ipopt::Matrix.

virtual void Ipopt::GenTMatrix::TransMultVectorImpl ( Number  alpha,
const Vector x,
Number  beta,
Vector y 
) const
protectedvirtual

Matrix(transpose) vector multiply.

Computes y = alpha * Matrix^T * x + beta * y

Implements Ipopt::Matrix.

virtual bool Ipopt::GenTMatrix::HasValidNumbersImpl ( ) const
protectedvirtual

Method for determining if all stored numbers are valid (i.e., no Inf or Nan).

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::GenTMatrix::ComputeRowAMaxImpl ( Vector rows_norms,
bool  init 
) const
protectedvirtual

Compute the max-norm of the rows in the matrix.

The result is stored in rows_norms. The vector is assumed to be initialized.

Implements Ipopt::Matrix.

virtual void Ipopt::GenTMatrix::ComputeColAMaxImpl ( Vector cols_norms,
bool  init 
) const
protectedvirtual

Compute the max-norm of the columns in the matrix.

The result is stored in cols_norms. The vector is assumed to be initialized.

Implements Ipopt::Matrix.

virtual void Ipopt::GenTMatrix::PrintImpl ( const Journalist jnlst,
EJournalLevel  level,
EJournalCategory  category,
const std::string &  name,
Index  indent,
const std::string &  prefix 
) const
inlineprotectedvirtual

Print detailed information about the matrix.

Implements Ipopt::Matrix.

Definition at line 107 of file IpGenTMatrix.hpp.

void Ipopt::GenTMatrix::PrintImplOffset ( const Journalist jnlst,
EJournalLevel  level,
EJournalCategory  category,
const std::string &  name,
Index  indent,
const std::string &  prefix,
Index  offset 
) const
protected
void Ipopt::GenTMatrix::operator= ( const GenTMatrix )
private

Overloaded Equals Operator.

Friends And Related Function Documentation

friend class ParGenMatrix
friend

Definition at line 126 of file IpGenTMatrix.hpp.

Member Data Documentation

const GenTMatrixSpace* Ipopt::GenTMatrix::owner_space_
private

Copy of the owner space as a GenTMatrixSpace instead of a MatrixSpace.

Definition at line 150 of file IpGenTMatrix.hpp.

Number* Ipopt::GenTMatrix::values_
private

Values of nonzeros.

Definition at line 153 of file IpGenTMatrix.hpp.

bool Ipopt::GenTMatrix::initialized_
private

Flag for Initialization.

Definition at line 156 of file IpGenTMatrix.hpp.


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