# Komplex_Ordering Class Reference

Komplex_Ordering: The Komplex Ordering Class. More...

`#include <Komplex_Ordering.h>`

Collaboration diagram for Komplex_Ordering:

[legend]
List of all members.

## Matrix converter methods

int ToCanonical (Komplex_RowMatrix *KForm, Komplex_RowMatrix &Canonical)
Convert a Komplex_RowMatrix to canonical form.
int ToKForm (Komplex_RowMatrix *Canonical, Komplex_RowMatrix &KForm)
Convert a Komplex_RowMatrix in canonical form to K form.

## Public Member Functions

Constructors/Destructor.
Komplex_Ordering ()
Komplex_Ordering Default Constructor.
Komplex_Ordering (Komplex_RowMatrix *A)
Komplex_Ordering Constructor to create the ordering for a Komplex_RowMatrix object.
Komplex_Ordering (const Komplex_Ordering &Ordering)
Komplex_Ordering Copy Constructor.
virtual ~Komplex_Ordering ()
Komplex_Ordering Destructor.

## Detailed Description

Komplex_Ordering: The Komplex Ordering Class.

The Komplex_Ordering class defines the ordering for a Komplex_RowMatrix object.

The different K forms (K1, K2, K3, K4, K14, and K23) of an equivalent real formulation can easily convert back and forth by going from one K form to the canonical form to another K form. The Komplex_Ordering that each Komplex_RowMatrix object has is what determines the conversions. Let Kanon stand for the canonical form of a complex matrix in equivalent real formulation. Then any K form is equivalent to: P_l * Kanon * P_r * D_r, where P_l, P_r are specific permutation matrices and D_r is a specific right diagonal scaling matrix. This is helpful because certain forms are advantageous in certain conditions. To be able to convert back and forth during preconditioning and solving should allow for faster, more accurate solutions.

## Constructor & Destructor Documentation

 Komplex_Ordering::Komplex_Ordering ( )
 Komplex_Ordering Default Constructor. Creates an empty Komplex_Ordering instance.

 Komplex_Ordering::Komplex_Ordering ( Komplex_RowMatrix * A )
 Komplex_Ordering Constructor to create the ordering for a Komplex_RowMatrix object. Creates a Komplex_Ordering instance for a given Komplex_RowMatrix object.

 Komplex_Ordering::Komplex_Ordering ( const Komplex_Ordering & Ordering )
 Komplex_Ordering Copy Constructor. Makes a copy of an existing Komplex_Ordering instance.

 virtual Komplex_Ordering::~Komplex_Ordering ( ) ` [virtual]`
 Komplex_Ordering Destructor. Completely deletes a Komplex_Ordering object.

## Member Function Documentation

 int Komplex_Ordering::ToCanonical ( Komplex_RowMatrix * KForm, Komplex_RowMatrix & Canonical )

Convert a Komplex_RowMatrix to canonical form.

Converts a given Komplex_RowMatrix into canonical form, returning the answer in a user-provided RowMatrix object.

Parameters:
 In KForm - RowMatrix to be converted to canonical form. Out Canonical - RowMatrix in canonical form.
Returns:
Integer error code, set to 0 if successful.

 int Komplex_Ordering::ToKForm ( Komplex_RowMatrix * Canonical, Komplex_RowMatrix & KForm )

Convert a Komplex_RowMatrix in canonical form to K form.

Converts a given Komplex_RowMatrix in canonical form to K form, returning the answer in a user-provided RowMatrix object.

Parameters:
 In Canonical - RowMatrix to be converted to K form. Out KForm - RowMatrix in K form.
Returns:
Integer error code, set to 0 if successful.

The documentation for this class was generated from the following file:
• Komplex_Ordering.h

Generated on Thu Sep 18 12:42:09 2008 for Komplex by  1.3.9.1