Anasazi::LOCASort Class Reference

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

#include <Anasazi_LOCA_Sort.H>

List of all members.

Public Member Functions
	LOCASort (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::EigenvalueSort::AbstractStrategy > &strategy_)
	Constructor.
virtual	~LOCASort ()
	Destructor.
virtual void	sort (std::vector< double > &evals, Teuchos::RCP< std::vector< int > > perm=Teuchos::null, int n=-1) const
	Sort the vector of eigenvalues with respect to the chosen sorting type, optionally returning the permutation vector.
virtual void	sort (std::vector< double > &r_evals, std::vector< double > &i_evals, Teuchos::RCP< std::vector< int > > perm=Teuchos::null, int n=-1) const
	Sort the vectors of eigenpairs with respect to the chosen sorting type, optionally returning the permutation vector.
Protected Attributes
Teuchos::RCP< LOCA::GlobalData >	globalData
	Global data.
Teuchos::RCP < LOCA::EigenvalueSort::AbstractStrategy >	strategy
	EigenvalueSort strategy.
Private Types
typedef NOX::Abstract::MultiVector	MV
	Anasazi::Multivec typedef.
typedef LOCA::AnasaziOperator::AbstractStrategy	OP
	Anasazi::Operator typedef.

---

Detailed Description

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

Definition at line 70 of file Anasazi_LOCA_Sort.H.

---

Member Typedef Documentation

typedef NOX::Abstract::MultiVector Anasazi::LOCASort::MV [private]

Anasazi::Multivec typedef.

Definition at line 74 of file Anasazi_LOCA_Sort.H.

typedef LOCA::AnasaziOperator::AbstractStrategy Anasazi::LOCASort::OP [private]

Anasazi::Operator typedef.

Definition at line 77 of file Anasazi_LOCA_Sort.H.

---

Constructor & Destructor Documentation

Anasazi::LOCASort::LOCASort	(	const Teuchos::RCP< LOCA::GlobalData > &	global_data,
		const Teuchos::RCP< LOCA::EigenvalueSort::AbstractStrategy > &	strategy_
	)

Constructor.

Parameters:

	global_data	[in] Global data object
	strategy_	[in] Ref-count ptr to LOCA sorting strategy

Definition at line 47 of file Anasazi_LOCA_Sort.C.

Anasazi::LOCASort::~LOCASort

(

)

[virtual]

Destructor.

Definition at line 55 of file Anasazi_LOCA_Sort.C.

---

Member Function Documentation

void Anasazi::LOCASort::sort	(	std::vector< double > &	evals,
		Teuchos::RCP< std::vector< int > >	perm = Teuchos::null,
		int	n = -1
	)			const [virtual]

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

Definition at line 60 of file Anasazi_LOCA_Sort.C.

References globalData, and strategy.

void Anasazi::LOCASort::sort	(	std::vector< double > &	r_evals,
		std::vector< double > &	i_evals,
		Teuchos::RCP< std::vector< int > >	perm = Teuchos::null,
		int	n = -1
	)			const [virtual]

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

Definition at line 72 of file Anasazi_LOCA_Sort.C.

References globalData, and strategy.

---

Member Data Documentation

Teuchos::RCP<LOCA::GlobalData> Anasazi::LOCASort::globalData [protected]

Global data.

Definition at line 123 of file Anasazi_LOCA_Sort.H.

Referenced by sort().

Teuchos::RCP<LOCA::EigenvalueSort::AbstractStrategy> Anasazi::LOCASort::strategy [protected]

EigenvalueSort strategy.

Definition at line 126 of file Anasazi_LOCA_Sort.H.

Referenced by sort().

---

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

• Anasazi_LOCA_Sort.H
• Anasazi_LOCA_Sort.C