Thyra::MultiVectorStdOpsTester< Scalar > Class Template Reference

Testing class that tests all of the standard vector operations defined in ??? using an arbitrary vector space. More...

#include <Thyra_MultiVectorStdOpsTesterDecl.hpp>

List of all members.

Public Types

typedef Teuchos::ScalarTraits<
Scalar >::magnitudeType 
ScalarMag
 

Public Member Functions

void warning_tol (const ScalarMag &warning_tol)
 Set the maximum relative error before a warning is generated.
void error_tol (const ScalarMag &error_tol)
 Set the maximum relative error before an error is generated.
void num_mv_cols (const int &num_mv_cols)
 Set the number of columns to use to create test MultiVectorBase objects.
 MultiVectorStdOpsTester (const ScalarMag &warning_tol=0, const ScalarMag &error_tol=0, const int num_mv_cols=4)
 
bool checkStdOps (const VectorSpaceBase< Scalar > &vecSpc, std::ostream *out=0, const bool &dumpAll=false)
 Run the tests using a vector space.


Detailed Description

template<class Scalar>
class Thyra::MultiVectorStdOpsTester< Scalar >

Testing class that tests all of the standard vector operations defined in ??? using an arbitrary vector space.

ToDo: Finish documentation!

Definition at line 44 of file Thyra_MultiVectorStdOpsTesterDecl.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::MultiVectorStdOpsTester< Scalar >::ScalarMag
 

Definition at line 48 of file Thyra_MultiVectorStdOpsTesterDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::MultiVectorStdOpsTester< Scalar >::MultiVectorStdOpsTester const ScalarMag warning_tol = 0,
const ScalarMag error_tol = 0,
const int  num_mv_cols = 4
 

Definition at line 41 of file Thyra_MultiVectorStdOpsTester.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::MultiVectorStdOpsTester< Scalar >::warning_tol const ScalarMag warning_tol  )  [inline]
 

Set the maximum relative error before a warning is generated.

Definition at line 51 of file Thyra_MultiVectorStdOpsTesterDecl.hpp.

template<class Scalar>
void Thyra::MultiVectorStdOpsTester< Scalar >::error_tol const ScalarMag error_tol  )  [inline]
 

Set the maximum relative error before an error is generated.

Definition at line 54 of file Thyra_MultiVectorStdOpsTesterDecl.hpp.

template<class Scalar>
void Thyra::MultiVectorStdOpsTester< Scalar >::num_mv_cols const int &  num_mv_cols  )  [inline]
 

Set the number of columns to use to create test MultiVectorBase objects.

Definition at line 58 of file Thyra_MultiVectorStdOpsTesterDecl.hpp.

template<class Scalar>
bool Thyra::MultiVectorStdOpsTester< Scalar >::checkStdOps const VectorSpaceBase< Scalar > &  vecSpc,
std::ostream *  out = 0,
const bool &  dumpAll = false
 

Run the tests using a vector space.

Parameters:
vecSpc [in] VectorBase space used to generate vectors in tests.
out [in/out] If out!=NULL then *out will receive output about the tests.
dumpAll [in] If true then vector elements will be printed after each transformation operation. Default is false.
Returns:
Returns true if all of the tests check out and false otherwise.

Definition at line 52 of file Thyra_MultiVectorStdOpsTester.hpp.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:32:33 2008 for Thyra Operator/Vector Support by doxygen 1.3.9.1