PyTrilinos::Anasazi::BasicSortEpetra Class Reference

Inheritance diagram for PyTrilinos::Anasazi::BasicSortEpetra:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Anasazi::BasicSortEpetra:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def setSortType
def sort
def __init__
def setSortType
def sort

Public Attributes

 this


Detailed Description

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

Chris Baker, Ulrich Hetmaniuk, Rich Lehoucq, and Heidi Thornquist

C++ includes: AnasaziBasicSort.hpp 

Member Function Documentation

def PyTrilinos::Anasazi::BasicSortEpetra::__init__ (   self,
  args 
)

__init__(self, ParameterList pl) -> BasicSortEpetra
__init__(self, string which = "LM") -> BasicSortEpetra

Anasazi::BasicSort< MagnitudeType >::BasicSort(const std::string
&which="LM")

String driven constructor.

Directly pass the string specifying sort strategy. See setSortType()
for valid options. 

def PyTrilinos::Anasazi::BasicSortEpetra::__init__ (   self,
  args 
)

__init__(self, ParameterList pl) -> BasicSortEpetra
__init__(self, string which = "LM") -> BasicSortEpetra

Anasazi::BasicSort< MagnitudeType >::BasicSort(const std::string
&which="LM")

String driven constructor.

Directly pass the string specifying sort strategy. See setSortType()
for valid options. 

def PyTrilinos::Anasazi::BasicSortEpetra::setSortType (   self,
  args 
)

setSortType(self, string which)

void
Anasazi::BasicSort< MagnitudeType >::setSortType(const std::string
&which)

Set sort type.

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 

def PyTrilinos::Anasazi::BasicSortEpetra::setSortType (   self,
  args 
)

setSortType(self, string which)

void
Anasazi::BasicSort< MagnitudeType >::setSortType(const std::string
&which)

Set sort type.

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 

def PyTrilinos::Anasazi::BasicSortEpetra::sort (   self,
  args 
)

sort(self, std::vector<(double,std::allocator<(double)>)> evals, 
    Teuchos::RCP<(std::vector<(int,std::allocator<(int)>)>)> perm = Teuchos::null, 
    int n = -1)
sort(self, std::vector<(double,std::allocator<(double)>)> r_evals, 
    std::vector<(double,std::allocator<(double)>)> i_evals, 
    Teuchos::RCP<(std::vector<(int,std::allocator<(int)>)>)> perm = Teuchos::null, 
    int n = -1)

void
Anasazi::BasicSort< MagnitudeType >::sort(std::vector< MagnitudeType >
&r_evals, std::vector< MagnitudeType > &i_evals, Teuchos::RCP<
std::vector< int > > perm=Teuchos::null, int n=-1) const

Sort complex eigenvalues, optionally returning the permutation vector.

This routine takes two vectors, one for each part of a complex
eigenvalue. This is helpful for solving real, non-symmetric eigenvalue
problems.

Parameters:
-----------

r_evals:  [in/out] Vector of length at least n containing the real
part of the eigenvalues to be sorted.  On output, the first n
eigenvalues will be sorted. The rest will be unchanged.

i_evals:  [in/out] Vector of length at least n containing the
imaginary part of the eigenvalues to be sorted.  On output, the first
n eigenvalues will be sorted. The rest will be unchanged.

perm:  [out] Vector of length at least n to store the permutation
index (optional).  If specified, on output the first n eigenvalues
will contain the permutation indices, in the range [0,n-1], such that
r_evals_out[i] = r_evals_in[perm[i]] and similarly for i_evals.

n:  [in] Number of values in r_evals, i_evals to be sorted. If n ==
-1, all values will be sorted, as decided by the minimum of the length
of r_evals and the length of i_evals. 

Reimplemented from PyTrilinos::Anasazi::SortManagerEpetra.

def PyTrilinos::Anasazi::BasicSortEpetra::sort (   self,
  args 
)

sort(self, std::vector<(double,std::allocator<(double)>)> evals, 
    Teuchos::RCP<(std::vector<(int,std::allocator<(int)>)>)> perm = Teuchos::null, 
    int n = -1)
sort(self, std::vector<(double,std::allocator<(double)>)> r_evals, 
    std::vector<(double,std::allocator<(double)>)> i_evals, 
    Teuchos::RCP<(std::vector<(int,std::allocator<(int)>)>)> perm = Teuchos::null, 
    int n = -1)

void
Anasazi::BasicSort< MagnitudeType >::sort(std::vector< MagnitudeType >
&r_evals, std::vector< MagnitudeType > &i_evals, Teuchos::RCP<
std::vector< int > > perm=Teuchos::null, int n=-1) const

Sort complex eigenvalues, optionally returning the permutation vector.

This routine takes two vectors, one for each part of a complex
eigenvalue. This is helpful for solving real, non-symmetric eigenvalue
problems.

Parameters:
-----------

r_evals:  [in/out] Vector of length at least n containing the real
part of the eigenvalues to be sorted.  On output, the first n
eigenvalues will be sorted. The rest will be unchanged.

i_evals:  [in/out] Vector of length at least n containing the
imaginary part of the eigenvalues to be sorted.  On output, the first
n eigenvalues will be sorted. The rest will be unchanged.

perm:  [out] Vector of length at least n to store the permutation
index (optional).  If specified, on output the first n eigenvalues
will contain the permutation indices, in the range [0,n-1], such that
r_evals_out[i] = r_evals_in[perm[i]] and similarly for i_evals.

n:  [in] Number of values in r_evals, i_evals to be sorted. If n ==
-1, all values will be sorted, as decided by the minimum of the length
of r_evals and the length of i_evals. 

Reimplemented from PyTrilinos::Anasazi::SortManagerEpetra.


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

Generated on Thu Dec 17 11:00:19 2009 for PyTrilinos by  doxygen 1.5.9