Belos Package Browser (Single Doxygen Collection) Development
Public Types | Static Public Member Functions | Private Types | Static Private Member Functions
Belos::Test::OrthoManagerTester< Scalar, MV > Class Template Reference

Wrapper around OrthoManager test functionality. More...

#include <BelosOrthoManagerTest.hpp>

List of all members.

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.

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.
static magnitude_type frobeniusNorm (const MV &X)
 Compute and return the Frobenius norm of X.
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.
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.
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.
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.
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.

Detailed Description

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

Wrapper around OrthoManager test functionality.

Definition at line 324 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 326 of file BelosOrthoManagerTest.hpp.

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

Definition at line 329 of file BelosOrthoManagerTest.hpp.

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

Definition at line 330 of file BelosOrthoManagerTest.hpp.

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

Definition at line 331 of file BelosOrthoManagerTest.hpp.

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

Definition at line 332 of file BelosOrthoManagerTest.hpp.

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

Definition at line 333 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 334 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 
) [inline, static]

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 353 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
Belos::Test::OrthoManagerTester< Scalar, MV >::MVDiff ( const MV &  X,
const MV &  Y 
) [inline, static, private]

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

Definition at line 767 of file BelosOrthoManagerTest.hpp.

template<class Scalar , class MV >
Belos::Test::OrthoManagerTester< Scalar, MV >::frobeniusNorm ( const MV &  X) [inline, static, private]

Compute and return the Frobenius norm of X.

Definition at line 791 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 
) [inline, static, private]

Definition at line 809 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 
) [inline, static, private]

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

Returns:
Count of errors (should be zero)

Definition at line 823 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 
) [inline, static, private]

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

Returns:
Count of errors (should be zero)

Definition at line 1131 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 
) [inline, static, private]

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

Returns:
Count of errors (should be zero)

Definition at line 1296 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 
) [inline, static, private]

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

Returns:
Count of errors (should be zero)

Definition at line 1473 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 
) [inline, static, private]

Definition at line 1596 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 
) [inline, static, private]

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

Returns:
Count of errors (should be zero)

Definition at line 1609 of file BelosOrthoManagerTest.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines