# Ipopt::TransposeMatrix Class Reference

Class for Matrices which are the transpose of another matrix. More...

`#include <IpTransposeMatrix.hpp>`

Inheritance diagram for Ipopt::TransposeMatrix:
[legend]

List of all members.

## Public Member Functions
Constructors / Destructors
| TransposeMatrix (const TransposeMatrixSpace *owner_space)
| Constructor, initializing with dimensions of the matrix.
| ~TransposeMatrix ()
| Destructor.
SmartPtr< const Matrix > | OrigMatrix () const
## Protected Member Functions
Methods overloaded from matrix
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 bool | HasValidNumbersImpl () const
| Method for determining if all stored numbers are valid (i.e., no Inf or Nan).
virtual void | ComputeRowAMaxImpl (Vector &rows_norms, bool init) const
| Compute the max-norm of the rows in the matrix.
virtual void | ComputeColAMaxImpl (Vector &rows_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.
| TransposeMatrix ()
| Default Constructor.
| TransposeMatrix (const TransposeMatrix &)
| Copy Constructor.
void | operator= (const TransposeMatrix &)
| Overloaded Equals Operator.
## Private Attributes
SmartPtr< Matrix > | orig_matrix_
| Pointer to original matrix.

## Detailed Description

Class for Matrices which are the transpose of another matrix.

Definition at line 23 of file IpTransposeMatrix.hpp.

## Constructor & Destructor Documentation

Ipopt::TransposeMatrix::TransposeMatrix | ( | const TransposeMatrixSpace * | owner_space | ) |

Constructor, initializing with dimensions of the matrix.

Ipopt::TransposeMatrix::~TransposeMatrix | ( |  | ) | `[inline]`

Destructor.

Definition at line 35 of file IpTransposeMatrix.hpp.

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

Default Constructor.

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

Copy Constructor.

## Member Function Documentation

SmartPtr<const Matrix> Ipopt::TransposeMatrix::OrigMatrix | ( |  | ) | const`[inline]`

Definition at line 38 of file IpTransposeMatrix.hpp.

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

Matrix-vector multiply.

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

Implements Ipopt::Matrix.

Definition at line 47 of file IpTransposeMatrix.hpp.

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

Matrix(transpose) vector multiply.

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

Implements Ipopt::Matrix.

Definition at line 54 of file IpTransposeMatrix.hpp.

virtual bool Ipopt::TransposeMatrix::HasValidNumbersImpl | ( |  | ) | const`[inline, protected, virtual]`

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

Reimplemented from Ipopt::Matrix.

Definition at line 63 of file IpTransposeMatrix.hpp.

virtual void Ipopt::TransposeMatrix::ComputeRowAMaxImpl | ( | Vector & | rows_norms,
|  | bool | init |
| ) |  |  | const`[inline, 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.

Definition at line 69 of file IpTransposeMatrix.hpp.

virtual void Ipopt::TransposeMatrix::ComputeColAMaxImpl | ( | Vector & | cols_norms,
|  | bool | init |
| ) |  |  | const`[inline, 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.

Definition at line 75 of file IpTransposeMatrix.hpp.

virtual void Ipopt::TransposeMatrix::PrintImpl | ( | const Journalist & | jnlst,
|  | EJournalLevel | level,
|  | EJournalCategory | category,
|  | const std::string & | name,
|  | Index | indent,
|  | const std::string & | prefix |
| ) |  |  | const`[protected, virtual]`

Print detailed information about the matrix.

Implements Ipopt::Matrix.

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

Overloaded Equals Operator.

Reimplemented from Ipopt::Matrix.

## Member Data Documentation

SmartPtr<Matrix> Ipopt::TransposeMatrix::orig_matrix_`[private]`

Pointer to original matrix.

Definition at line 109 of file IpTransposeMatrix.hpp.

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

- src/LinAlg/IpTransposeMatrix.hpp

All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines