Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Static Public Member Functions | Private Types | Static Private Member Functions | List of all members
Belos::Test::OrthoManagerTester< Scalar, MV > Class Template Reference

Wrapper around OrthoManager test functionality. More...

#include <BelosOrthoManagerTest.hpp>

Public Types

typedef Scalar scalar_type
 
typedef Teuchos::ScalarTraits
< scalar_type > 		SCT
 
typedef SCT::magnitudeType magnitude_type
 
typedef Teuchos::ScalarTraits
< magnitude_type > 		SMT
 
typedef MultiVecTraits
< scalar_type, MV > 		MVT
 
typedef
Teuchos::SerialDenseMatrix
< int, scalar_type > 		mat_type
 

Static Public Member Functions

static int runTests (const Teuchos::RCP< OrthoManager< Scalar, MV > > &OM, const bool isRankRevealing, const Teuchos::RCP< MV > &S, const int sizeX1, const int sizeX2, const Teuchos::RCP< OutputManager< Scalar > > &MyOM)
 Run all the tests. More...
 

Private Types

typedef Teuchos::Array
< Teuchos::RCP< MV >
>::size_type 		size_type
 

Static Private Member Functions

static magnitude_type MVDiff (const MV &X, const MV &Y)
 Compute and return $|X - Y|_F$, the Frobenius (sum of squares) norm of the difference between X and Y. More...
 
static magnitude_type frobeniusNorm (const MV &X)
 Compute and return the Frobenius norm of X. More...
 
static int testProjectAndNormalize (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< const MV > &X1, const Teuchos::RCP< const MV > &X2, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 
static int testProjectAndNormalizeOld (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > &OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< const MV > &X1, const Teuchos::RCP< const MV > &X2, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 Test OrthoManager::projectAndNormalize() for the specific OrthoManager instance. More...
 
static int testNormalize (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > &OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 Test OrthoManager::normalize() for the specific OrthoManager instance. More...
 
static int testNormalizeRankReveal (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > &OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 Test OrthoManager::normalize() for the specific OrthoManager instance. More...
 
static int testProjectAndNormalizeNew (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< const MV > &X1, const Teuchos::RCP< const MV > &X2, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 Test OrthoManager::projectAndNormalize() for the specific OrthoManager instance. More...
 
static int testProjectNew (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< const MV > &X1, const Teuchos::RCP< const MV > &X2, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 Test OrthoManager::project() for the specific OrthoManager instance. More...
 
static int testProject (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< const MV > &X1, const Teuchos::RCP< const MV > &X2, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 
static int testProjectOld (const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > OM, const Teuchos::RCP< const MV > &S, const Teuchos::RCP< const MV > &X1, const Teuchos::RCP< const MV > &X2, const Teuchos::RCP< Belos::OutputManager< Scalar > > &MyOM)
 Test OrthoManager::project() for the specific OrthoManager instance. More...
 

Detailed Description

template<class Scalar, class MV>
class Belos::Test::OrthoManagerTester< Scalar, MV >

Wrapper around OrthoManager test functionality.

Definition at line 325 of file BelosOrthoManagerTest.hpp.

Member Typedef Documentation

template<class Scalar , class MV >
typedef Teuchos::Array<Teuchos::RCP<MV> >::size_type Belos::Test::OrthoManagerTester< Scalar, MV >::size_type
private

Definition at line 327 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
typedef Scalar Belos::Test::OrthoManagerTester< Scalar, MV >::scalar_type

Definition at line 330 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
typedef Teuchos::ScalarTraits<scalar_type> Belos::Test::OrthoManagerTester< Scalar, MV >::SCT

Definition at line 331 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
typedef SCT::magnitudeType Belos::Test::OrthoManagerTester< Scalar, MV >::magnitude_type

Definition at line 332 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
typedef Teuchos::ScalarTraits<magnitude_type> Belos::Test::OrthoManagerTester< Scalar, MV >::SMT

Definition at line 333 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
typedef MultiVecTraits<scalar_type, MV> Belos::Test::OrthoManagerTester< Scalar, MV >::MVT

Definition at line 334 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
typedef Teuchos::SerialDenseMatrix<int, scalar_type> Belos::Test::OrthoManagerTester< Scalar, MV >::mat_type

Definition at line 335 of file BelosOrthoManagerTest.hpp.

Member Function Documentation

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::runTests ( const Teuchos::RCP< OrthoManager< Scalar, MV > > &  OM,
const bool  isRankRevealing,
const Teuchos::RCP< MV > &  S,
const int  sizeX1,
const int  sizeX2,
const Teuchos::RCP< OutputManager< Scalar > > &  MyOM 
)
inlinestatic

Run all the tests.

Parameters
OM[in/out] OrthoManager subclass instance to test
isRankRevealing[in] Whether that OrthoManager subclass instance has a true rank-revealing capability. If not, we do not test it on rank-deficient vectors.
S[in/out] Multivector instance
sizeX1[in] Number of columns in X1 (a multivector instance created internally for tests)
sizeX2[in] Number of columns in X2 (a multivector instance created internally for tests)
MyOM[out] Output manager for handling local output. In Anasazi, this class is called BasicOutputManager. In Belos, this class is called OutputManager.
Returns
Number of tests that failed (zero means success)

Definition at line 354 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
Belos::Test::OrthoManagerTester< Scalar, MV >::MVDiff ( const MV &  X,
const MV &  Y 
)
inlinestaticprivate

Compute and return $|X - Y|_F$, the Frobenius (sum of squares) norm of the difference between X and Y.

Definition at line 782 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
Belos::Test::OrthoManagerTester< Scalar, MV >::frobeniusNorm ( const MV &  X)
inlinestaticprivate

Compute and return the Frobenius norm of X.

Definition at line 806 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testProjectAndNormalize ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > >  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< const MV > &  X1,
const Teuchos::RCP< const MV > &  X2,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Definition at line 824 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testProjectAndNormalizeOld ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > &  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< const MV > &  X1,
const Teuchos::RCP< const MV > &  X2,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Test OrthoManager::projectAndNormalize() for the specific OrthoManager instance.

Returns
Count of errors (should be zero)

Definition at line 838 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testNormalize ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > &  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Test OrthoManager::normalize() for the specific OrthoManager instance.

Returns
Count of errors (should be zero)

Definition at line 1146 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testNormalizeRankReveal ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > > &  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Test OrthoManager::normalize() for the specific OrthoManager instance.

Returns
Count of errors (should be zero)

Definition at line 1180 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testProjectAndNormalizeNew ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > >  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< const MV > &  X1,
const Teuchos::RCP< const MV > &  X2,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Test OrthoManager::projectAndNormalize() for the specific OrthoManager instance.

Returns
Count of errors (should be zero)

Definition at line 1345 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testProjectNew ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > >  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< const MV > &  X1,
const Teuchos::RCP< const MV > &  X2,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Test OrthoManager::project() for the specific OrthoManager instance.

Returns
Count of errors (should be zero)

Definition at line 1522 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testProject ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > >  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< const MV > &  X1,
const Teuchos::RCP< const MV > &  X2,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Definition at line 1645 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
static int Belos::Test::OrthoManagerTester< Scalar, MV >::testProjectOld ( const Teuchos::RCP< Belos::OrthoManager< Scalar, MV > >  OM,
const Teuchos::RCP< const MV > &  S,
const Teuchos::RCP< const MV > &  X1,
const Teuchos::RCP< const MV > &  X2,
const Teuchos::RCP< Belos::OutputManager< Scalar > > &  MyOM 
)
inlinestaticprivate

Test OrthoManager::project() for the specific OrthoManager instance.

Returns
Count of errors (should be zero)

Definition at line 1658 of file BelosOrthoManagerTest.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5