Epetra Development
Epetra_OskiPermutation Class Reference

Epetra_OskiPermutation: A class for storing the permutation performed on a Epetra_OskiMatrix. More...

#include <Epetra_OskiPermutation.h>

List of all members.

Public Member Functions

Constructor/Destructor
 Epetra_OskiPermutation ()
 Default Constructor.
 Epetra_OskiPermutation (const Epetra_OskiPermutation &Source)
 Copy Constructor.
 Epetra_OskiPermutation (bool RowPerm, const Epetra_OskiMatrix &Source)
 Constructor creates an Epetra_OskiPermutation from an Epetra_OskiMatrix.
virtual ~Epetra_OskiPermutation ()
 Destructor.
Replace Method
void ReplacePermutation (const oski_perm_t &InPerm)
 Stores a permutation in the data structure.
Apply
int PermuteVector (const bool TransA, Epetra_OskiMultiVector &Vector) const
 Permutes Vector according to the Permutation. If a transpose is desired it performs that operation.

Detailed Description

Epetra_OskiPermutation: A class for storing the permutation performed on a Epetra_OskiMatrix.

The Epetra_OskiPermutation is one of the possible transformations that OSKI can perform on a matrix. The permutation is stored with the matrix in OSKI. Using this class a Epetra_OskiPermutation can be applied to an Epetra_OskiMultiVector.


Constructor & Destructor Documentation

Epetra_OskiPermutation::Epetra_OskiPermutation ( bool  RowPerm,
const Epetra_OskiMatrix Source 
)

Constructor creates an Epetra_OskiPermutation from an Epetra_OskiMatrix.

Acquires the permutation from the passed in matrix and stores it within the object. If RowPerm is true this is a row permutation and if RowPerm is false this is a column permutation.


Member Function Documentation

int Epetra_OskiPermutation::PermuteVector ( const bool  TransA,
Epetra_OskiMultiVector Vector 
) const

Permutes Vector according to the Permutation. If a transpose is desired it performs that operation.

The Vector passed into this function is a view. It is the underlying object that is permuted by the function.

Parameters:
TransA(In) If TransA = TRUE then use the transpose of the permutation and apply it to Vector.
Vector(In/Out) The vector that is permuted by Permutation^Trans.
Returns:
When successful returns 0. On error Vector is not permuted and a error code is returned.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Enumerator