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

An implementation of the Anasazi::SortManager that performs a collection of common sorting techniques. More...

#include <Anasazi_LOCA_Sort.H>

Collaboration diagram for Anasazi::LOCASort< ScalarType, MV, OP >:

[legend]
List of all members.

Public Member Functions

 LOCASort (const string which="LM", ScalarType cayleyPole=Teuchos::ScalarTraits< ScalarType >::zero(), ScalarType cayleyZero=Teuchos::ScalarTraits< ScalarType >::zero())
 Constructor.
virtual ~LOCASort ()
 Destructor.
ReturnType sort (Eigensolver< ScalarType, MV, OP > *solver, int n, ScalarType *evals, std::vector< int > *perm=0) const
 Sort the vector of eigenvalues with respect to the chosen sorting type, optionally returning the permutation vector.
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 with respect to the chosen sorting type, optionally returning the permutation vector.

Protected Attributes

string _which
ScalarType _sigma
ScalarType _mu

Detailed Description

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

An implementation of the Anasazi::SortManager that performs a collection of common sorting techniques.


Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>
Anasazi::LOCASort< ScalarType, MV, OP >::LOCASort const string  which = "LM",
ScalarType  cayleyPole = Teuchos::ScalarTraits<ScalarType>::zero(),
ScalarType  cayleyZero = Teuchos::ScalarTraits<ScalarType>::zero()
[inline]
 

Constructor.

Parameters:
which [in] The eigenvalues of interest for this eigenproblem.
  • "LM" - Largest Magnitude [ default ]
  • "SM" - Smallest Magnitude
  • "LR" - Largest Real
  • "SR" - Smallest Real
  • "LI" - Largest Imaginary
  • "SI" - Smallest Imaginary
  • "CA" - Cayley Sorting


Member Function Documentation

template<class ScalarType, class MV, class OP>
ReturnType Anasazi::LOCASort< ScalarType, MV, OP >::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 with respect to the chosen sorting type, 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 ]

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

Sort the vector of eigenvalues with respect to the chosen sorting type, 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 ]


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:42:22 2008 for NOX by doxygen 1.3.9.1