Anasazi::SortManager< ScalarType, MV, OP > Class Template Reference

Anasazi's templated pure virtual class for managing the sorting of approximate eigenvalues computed by the eigensolver. More...

#include <AnasaziSortManager.hpp>

Inheritance diagram for Anasazi::SortManager< ScalarType, MV, OP >:

[legend]
List of all members.

Public Member Functions

 SortManager ()
 Default Constructor.
virtual ~SortManager ()
 Destructor.
virtual ReturnType sort (Eigensolver< ScalarType, MV, OP > *solver, int n, ScalarType *evals, std::vector< int > *perm=0) const
 Sort the vector of eigenvalues, optionally returning the permutation vector.
virtual ReturnType sort (Eigensolver< ScalarType, MV, OP > *solver, int n, ScalarType *r_evals, ScalarType *i_evals, std::vector< int > *perm=0) const
 Sort the vectors of eigenpairs, optionally returning the permutation vector.

Detailed Description

template<class ScalarType, class MV, class OP>
class Anasazi::SortManager< ScalarType, MV, OP >

Anasazi's templated pure virtual class for managing the sorting of approximate eigenvalues computed by the eigensolver.

A concrete implementation of this class is necessary. The user can create their own implementation if those supplied are not suitable for their needs.

Author:
Ulrich Hetmaniuk, Rich Lehoucq, and Heidi Thornquist


Member Function Documentation

template<class ScalarType, class MV, class OP>
virtual ReturnType Anasazi::SortManager< ScalarType, MV, OP >::sort Eigensolver< ScalarType, MV, OP > *  solver,
int  n,
ScalarType *  r_evals,
ScalarType *  i_evals,
std::vector< int > *  perm = 0
const [inline, virtual]
 

Sort the vectors of eigenpairs, optionally returning the permutation vector.

Parameters:
solver [in] Eigensolver that is calling the sorting routine
n [in] Size of the array
r_evals [in/out] Array of length n containing the real part of the eigenvalues to be sorted
i_evals [in/out] Array of length n containing the imaginary part of the eigenvalues to be sorted
perm [out] Vector of length n to store the permutation (optional)
Returns:
Returns the status of the sorting routine [ Undefined by default ]

Reimplemented in Anasazi::BasicSort< ScalarType, MV, OP >.

template<class ScalarType, class MV, class OP>
virtual ReturnType Anasazi::SortManager< ScalarType, MV, OP >::sort Eigensolver< ScalarType, MV, OP > *  solver,
int  n,
ScalarType *  evals,
std::vector< int > *  perm = 0
const [inline, virtual]
 

Sort the vector of eigenvalues, optionally returning the permutation vector.

Parameters:
solver [in] Eigensolver that is calling the sorting routine
n [in] Size of the array
evals [in/out] Array of length n containing the eigenvalues to be sorted
perm [out] Vector of length n to store the permutation (optional)
Returns:
Returns the status of the sorting routine [ Undefined by default ]

Reimplemented in Anasazi::BasicSort< ScalarType, MV, OP >.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:41:36 2008 for Anasazi by doxygen 1.3.9.1