# Ipopt::ExpansionMatrix Class Reference

Class for expansion/projection matrices. More...

`#include <IpExpansionMatrix.hpp>`

Inheritance diagram for Ipopt::ExpansionMatrix:
[legend]

List of all members.

## Public Member Functions
const Index * | ExpandedPosIndices () const
| Return the vector of indices marking the expanded position.
const Index * | CompressedPosIndices () const
| Return the vector of indices marking the compressed position.
Constructors / Destructors
| ExpansionMatrix (const ExpansionMatrixSpace *owner_space)
| Constructor, taking the owner_space.
| ~ExpansionMatrix ()
| Destructor.
## Protected Member Functions
void | PrintImplOffset (const Journalist &jnlst, EJournalLevel level, EJournalCategory category, const std::string &name, Index indent, const std::string &prefix, Index row_offset, Index col_offset) const
Overloaded methods from Matrix base class
virtual void | MultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
| Matrix-vector multiply.
virtual void | TransMultVectorImpl (Number alpha, const Vector &x, Number beta, Vector &y) const
| Matrix(transpose) vector multiply.
virtual void | AddMSinvZImpl (Number alpha, const Vector &S, const Vector &Z, Vector &X) const
| X = beta*X + alpha*(Matrix S^{-1} Z).
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).
virtual void | ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
| Compute the max-norm of the rows in the matrix.
virtual void | ComputeColAMaxImpl (Vector &cols_norms, bool init) const
| Compute the max-norm of the columns in the matrix.
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.
## 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.
| ExpansionMatrix ()
| Default Constructor.
| ExpansionMatrix (const ExpansionMatrix &)
| Copy Constructor.
void | operator= (const ExpansionMatrix &)
| Overloaded Equals Operator.
## Private Attributes
const ExpansionMatrixSpace * | owner_space_
## Friends
class | ParExpansionMatrix

## Detailed Description

Class for expansion/projection matrices.

These matrices allow to lift a vector to a vector with larger dimension, keeping some elements of the larger vector zero. This operation is achieved by the MultVector operation. The transpose operation then filters some elements from a large vector into a smaller vector.

Definition at line 27 of file IpExpansionMatrix.hpp.

## Constructor & Destructor Documentation

Ipopt::ExpansionMatrix::ExpansionMatrix | ( | const ExpansionMatrixSpace * | owner_space | ) |

Constructor, taking the owner_space.

Ipopt::ExpansionMatrix::~ExpansionMatrix | ( |  | ) |

Destructor.

Ipopt::ExpansionMatrix::ExpansionMatrix | ( |  | ) | `[private]`

Default Constructor.

Ipopt::ExpansionMatrix::ExpansionMatrix | ( | const ExpansionMatrix & |  | ) | `[private]`

Copy Constructor.

## Member Function Documentation

const Index * Ipopt::ExpansionMatrix::ExpandedPosIndices | ( |  | ) | const`[inline]`

Return the vector of indices marking the expanded position.

The result is the Index array (of length NSmallVec=NCols()) that stores the mapping from the small vector to the large vector. For each element i=0,..,NSmallVec in the small vector, ExpandedPosIndices()[i] give the corresponding index in the large vector.

Definition at line 200 of file IpExpansionMatrix.hpp.

const Index * Ipopt::ExpansionMatrix::CompressedPosIndices | ( |  | ) | const`[inline]`

Return the vector of indices marking the compressed position.

The result is the Index array (of length NLargeVec=NRows()) that stores the mapping from the large vector to the small vector. For each element i=0,..,NLargeVec in the large vector, CompressedPosIndices()[i] gives the corresponding index in the small vector, unless CompressedPosIndices()[i] is negative.

Definition at line 206 of file IpExpansionMatrix.hpp.

virtual void Ipopt::ExpansionMatrix::MultVectorImpl | ( | Number | alpha,
|  | const Vector & | x,
|  | Number | beta,
|  | Vector & | y |
| ) |  |  | const`[protected, virtual]`

Matrix-vector multiply.

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

Implements Ipopt::Matrix.

virtual void Ipopt::ExpansionMatrix::TransMultVectorImpl | ( | Number | alpha,
|  | const Vector & | x,
|  | Number | beta,
|  | Vector & | y |
| ) |  |  | const`[protected, virtual]`

Matrix(transpose) vector multiply.

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

Implements Ipopt::Matrix.

virtual void Ipopt::ExpansionMatrix::AddMSinvZImpl | ( | Number | alpha,
|  | const Vector & | S,
|  | const Vector & | Z,
|  | Vector & | X |
| ) |  |  | const`[protected, virtual]`

X = beta*X + alpha*(Matrix S^{-1} Z).

Specialized implementation.

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::ExpansionMatrix::SinvBlrmZMTdBrImpl | ( | Number | alpha,
|  | const Vector & | S,
|  | const Vector & | R,
|  | const Vector & | Z,
|  | const Vector & | D,
|  | Vector & | X |
| ) |  |  | const`[protected, virtual]`

X = S^{-1} (r + alpha*Z*M^Td).

Specialized implementation.

Reimplemented from Ipopt::Matrix.

virtual void Ipopt::ExpansionMatrix::ComputeRowAMaxImpl | ( | Vector & | rows_norms,
|  | bool | init |
| ) |  |  | const`[protected, virtual]`

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::ExpansionMatrix::ComputeColAMaxImpl | ( | Vector & | cols_norms,
|  | bool | init |
| ) |  |  | const`[protected, virtual]`

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::ExpansionMatrix::PrintImpl | ( | const Journalist & | jnlst,
|  | EJournalLevel | level,
|  | EJournalCategory | category,
|  | const std::string & | name,
|  | Index | indent,
|  | const std::string & | prefix |
| ) |  |  | const`[inline, protected, virtual]`

Print detailed information about the matrix.

Implements Ipopt::Matrix.

Definition at line 85 of file IpExpansionMatrix.hpp.

void Ipopt::ExpansionMatrix::PrintImplOffset | ( | const Journalist & | jnlst,
|  | EJournalLevel | level,
|  | EJournalCategory | category,
|  | const std::string & | name,
|  | Index | indent,
|  | const std::string & | prefix,
|  | Index | row_offset,
|  | Index | col_offset |
| ) |  |  | const`[protected]`

void Ipopt::ExpansionMatrix::operator= | ( | const ExpansionMatrix & |  | ) | `[private]`

Overloaded Equals Operator.

Reimplemented from Ipopt::Matrix.

## Friends And Related Function Documentation

friend class ParExpansionMatrix`[friend]`

Definition at line 105 of file IpExpansionMatrix.hpp.

## Member Data Documentation

const ExpansionMatrixSpace* Ipopt::ExpansionMatrix::owner_space_`[private]`

Reimplemented from Ipopt::Matrix.

Definition at line 126 of file IpExpansionMatrix.hpp.

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

- src/LinAlg/IpExpansionMatrix.hpp

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines