PyTrilinos::Anasazi::StatusTestComboEpetra Class Reference

Inheritance diagram for PyTrilinos::Anasazi::StatusTestComboEpetra:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def checkStatus
def getStatus
def whichVecs
def howMany
def setComboType
def getComboType
def setTests
def getTests
def addTest
def removeTest
def reset
def clearStatus
def __init__
def checkStatus
def getStatus
def whichVecs
def howMany
def setComboType
def getComboType
def setTests
def getTests
def addTest
def removeTest
def reset
def clearStatus

Public Attributes

 this

Static Public Attributes

 OR = _Anasazi.StatusTestComboEpetra_OR
 AND = _Anasazi.StatusTestComboEpetra_AND
 SEQOR = _Anasazi.StatusTestComboEpetra_SEQOR
 SEQAND = _Anasazi.StatusTestComboEpetra_SEQAND


Detailed Description

Status test for forming logical combinations of other status tests.

Test types include StatusTestCombo::OR, StatusTestCombo::AND,
StatusTestCombo::SEQOR and StatusTestCombo::SEQAND. The
StatusTestCombo::OR and StatusTestCombo::AND tests evaluate all of the
tests, in the order they were passed to the StatusTestCombo. The
StatusTestCombo::SEQOR and StatusTestCombo::SEQAND run only the tests
necessary to determine the final outcome, short- circuiting on the
first test that conclusively decides the outcome. More formally,
StatusTestCombo::SEQAND runs the tests in the order they were given to
the StatusTestCombo class and stops after the first test that
evaluates Failed. StatusTestCombo::SEQOR run the tests in the order
they were given to the StatusTestCombo class and stops after the first
test that evaluates Passed.

C++ includes: AnasaziStatusTestCombo.hpp 

Member Function Documentation

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

__init__(self) -> StatusTestComboEpetra
__init__(self, ComboType type, Teuchos::Array<(Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>)> tests) -> StatusTestComboEpetra

Anasazi::StatusTestCombo< ScalarType, MV, OP
>::StatusTestCombo(ComboType type, Teuchos::Array< Teuchos::RCP<
StatusTest< ScalarType, MV, OP > > > tests)

Constructor specifying the StatusTestCombo::ComboType and the tests.

Constructor 

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

__init__(self) -> StatusTestComboEpetra
__init__(self, ComboType type, Teuchos::Array<(Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>)> tests) -> StatusTestComboEpetra

Anasazi::StatusTestCombo< ScalarType, MV, OP
>::StatusTestCombo(ComboType type, Teuchos::Array< Teuchos::RCP<
StatusTest< ScalarType, MV, OP > > > tests)

Constructor specifying the StatusTestCombo::ComboType and the tests.

Constructor 

def PyTrilinos::Anasazi::StatusTestComboEpetra::addTest (   self,
  args 
)

addTest(self, Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> test)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::addTest(Teuchos::RCP<
StatusTest< ScalarType, MV, OP > > test)

Add a test to the combination.

This also resets the test status to Undefined. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::addTest (   self,
  args 
)

addTest(self, Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> test)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::addTest(Teuchos::RCP<
StatusTest< ScalarType, MV, OP > > test)

Add a test to the combination.

This also resets the test status to Undefined. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::checkStatus (   self,
  args 
)

checkStatus(self, EigensolverEpetra solver) -> TestStatus

TestStatus Anasazi::StatusTestCombo< ScalarType, MV, OP
>::checkStatus(Eigensolver< ScalarType, MV, OP > *solver)

Check status as defined by test.

TestStatus indicating whether the test passed or failed. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::checkStatus (   self,
  args 
)

checkStatus(self, EigensolverEpetra solver) -> TestStatus

TestStatus Anasazi::StatusTestCombo< ScalarType, MV, OP
>::checkStatus(Eigensolver< ScalarType, MV, OP > *solver)

Check status as defined by test.

TestStatus indicating whether the test passed or failed. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::clearStatus (   self,
  args 
)

clearStatus(self)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::clearStatus()

Clears the results of the last status test.

This should be distinguished from the reset() method, as it only
clears the cached result from the last status test, so that a call to
getStatus() will return Undefined. This is necessary for the
StatusTestCombo::SEQOR and StatusTestCombo::SEQAND tests in the
StatusTestCombo class, which may short circuit and not evaluate all of
the StatusTests contained in them. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::clearStatus (   self,
  args 
)

clearStatus(self)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::clearStatus()

Clears the results of the last status test.

This should be distinguished from the reset() method, as it only
clears the cached result from the last status test, so that a call to
getStatus() will return Undefined. This is necessary for the
StatusTestCombo::SEQOR and StatusTestCombo::SEQAND tests in the
StatusTestCombo class, which may short circuit and not evaluate all of
the StatusTests contained in them. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::getComboType (   self,
  args 
)

getComboType(self) -> ComboType

ComboType Anasazi::StatusTestCombo< ScalarType, MV, OP
>::getComboType() const

Get the maximum number of iterations. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::getComboType (   self,
  args 
)

getComboType(self) -> ComboType

ComboType Anasazi::StatusTestCombo< ScalarType, MV, OP
>::getComboType() const

Get the maximum number of iterations. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::getStatus (   self,
  args 
)

getStatus(self) -> TestStatus

TestStatus Anasazi::StatusTestCombo< ScalarType, MV, OP >::getStatus()
const

Return the result of the most recent checkStatus call. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::getStatus (   self,
  args 
)

getStatus(self) -> TestStatus

TestStatus Anasazi::StatusTestCombo< ScalarType, MV, OP >::getStatus()
const

Return the result of the most recent checkStatus call. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::getTests (   self,
  args 
)

getTests(self) -> Teuchos::Array<(Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>)>

Teuchos::Array<Teuchos::RCP<StatusTest<ScalarType,MV,OP> > >
Anasazi::StatusTestCombo< ScalarType, MV, OP >::getTests() const

Get the tests. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::getTests (   self,
  args 
)

getTests(self) -> Teuchos::Array<(Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>)>

Teuchos::Array<Teuchos::RCP<StatusTest<ScalarType,MV,OP> > >
Anasazi::StatusTestCombo< ScalarType, MV, OP >::getTests() const

Get the tests. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::howMany (   self,
  args 
)

howMany(self) -> int

int
Anasazi::StatusTestCombo< ScalarType, MV, OP >::howMany() const

Get the number of vectors that passed the test. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::howMany (   self,
  args 
)

howMany(self) -> int

int
Anasazi::StatusTestCombo< ScalarType, MV, OP >::howMany() const

Get the number of vectors that passed the test. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::removeTest (   self,
  args 
)

removeTest(self, Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> test)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::removeTest(const
Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &test)

Removes a test from the combination, if it exists in the tester.

This also resets the test status to Undefined, if a test was removed.

def PyTrilinos::Anasazi::StatusTestComboEpetra::removeTest (   self,
  args 
)

removeTest(self, Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)> test)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::removeTest(const
Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &test)

Removes a test from the combination, if it exists in the tester.

This also resets the test status to Undefined, if a test was removed.

def PyTrilinos::Anasazi::StatusTestComboEpetra::reset (   self,
  args 
)

reset(self)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::reset()

Informs the status test that it should reset its internal
configuration to the uninitialized state.

The StatusTestCombo class has no internal state, but children classes
might, so this method will call reset() on all child status tests. It
also resets the test status to Undefined. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::reset (   self,
  args 
)

reset(self)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::reset()

Informs the status test that it should reset its internal
configuration to the uninitialized state.

The StatusTestCombo class has no internal state, but children classes
might, so this method will call reset() on all child status tests. It
also resets the test status to Undefined. 

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::setComboType (   self,
  args 
)

setComboType(self, ComboType type)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::setComboType(ComboType
type)

Set the maximum number of iterations. This also resets the test status
to Undefined. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::setComboType (   self,
  args 
)

setComboType(self, ComboType type)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP >::setComboType(ComboType
type)

Set the maximum number of iterations. This also resets the test status
to Undefined. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::setTests (   self,
  args 
)

setTests(self, Teuchos::Array<(Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>)> tests)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP
>::setTests(Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV,
OP > > > tests)

Set the tests This also resets the test status to Undefined. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::setTests (   self,
  args 
)

setTests(self, Teuchos::Array<(Teuchos::RCP<(Anasazi::StatusTest<(double,Epetra_MultiVector,Epetra_Operator)>)>)> tests)

void
Anasazi::StatusTestCombo< ScalarType, MV, OP
>::setTests(Teuchos::Array< Teuchos::RCP< StatusTest< ScalarType, MV,
OP > > > tests)

Set the tests This also resets the test status to Undefined. 

def PyTrilinos::Anasazi::StatusTestComboEpetra::whichVecs (   self,
  args 
)

whichVecs(self) -> VectorInt

std::vector<int> Anasazi::StatusTestCombo< ScalarType, MV, OP
>::whichVecs() const

Get the indices for the vectors that passed the test.

This returns some combination of the passing vectors from the tests
comprising the StatusTestCombo. The nature of the combination depends
on the StatusTestCombo::ComboType:  StatusTestCombo::SEQOR,
StatusTestCombo::OR - whichVecs() returns the union of whichVecs()
from all evaluated constituent tests

StatusTestCombo::SEQAND, StatusTestCombo::AND - whichVecs() returns
the intersection of whichVecs() from all evaluated constituent tests

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.

def PyTrilinos::Anasazi::StatusTestComboEpetra::whichVecs (   self,
  args 
)

whichVecs(self) -> VectorInt

std::vector<int> Anasazi::StatusTestCombo< ScalarType, MV, OP
>::whichVecs() const

Get the indices for the vectors that passed the test.

This returns some combination of the passing vectors from the tests
comprising the StatusTestCombo. The nature of the combination depends
on the StatusTestCombo::ComboType:  StatusTestCombo::SEQOR,
StatusTestCombo::OR - whichVecs() returns the union of whichVecs()
from all evaluated constituent tests

StatusTestCombo::SEQAND, StatusTestCombo::AND - whichVecs() returns
the intersection of whichVecs() from all evaluated constituent tests

Reimplemented from PyTrilinos::Anasazi::StatusTestEpetra.


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