Thyra::MultiVectorTester< Scalar > Class Template Reference
[Development of linear Abstract Numerical Algorithms (ANAs) (Client Support)]

Unit testing class for a MultiVectorBase object. More...

#include <Thyra_MultiVectorTester_decl.hpp>

Inheritance diagram for Thyra::MultiVectorTester< Scalar >:

Inheritance graph
[legend]
List of all members.

Depreicated.

THYRA_DEPRECATED bool check (const MultiVectorBase< Scalar > &mv, Teuchos::FancyOStream *out) const
 Deprecated.

Public Types

typedef Teuchos::ScalarTraits<
Scalar >::magnitudeType 
ScalarMag
 Local typedef for scalar magnitude.

Public Member Functions

LinearOpTester< Scalar > & linearOpTester ()
 Expose a non-const reference to the LinearOpTester object used to test the LinearOpBase interface supported by MultiVectorBase.
const LinearOpTester< Scalar > & linearOpTester () const
 Expose a const reference to the LinearOpTester object used to test the LinearOpBase interface supported by MultiVectorBase.
void warning_tol (const ScalarMag &warning_tol)
 Set the tolerance above which a relative error will generate a warning message.
ScalarMag warning_tol () const
 Return the warning tolerance for *this.
void error_tol (const ScalarMag &error_tol)
 Set the error above which a relative error will generate a an message and cause the test to fail.
ScalarMag error_tol () const
 Return the error tolerance for *this.
void num_random_vectors (const int num_random_vectors)
 Set the number random vectors that is generated during each test.
int num_random_vectors () const
 Return the number of random vectors used for *this objects tests.
void show_all_tests (const bool show_all_tests)
 Set whether all of the tests will be printed independent if they pass or fail.
bool show_all_tests () const
 Return the number of random vectors used for *this objects tests.
void dump_all (const bool dump_all)
 Set whether all of the vectors and multi-vectors will be dumped or not.
bool dump_all () const
 Return the number of random vectors used for *this objects tests.
 MultiVectorTester (const ScalarMag warning_tol=1e-13, const ScalarMag error_tol=1e-10, const int num_random_vectors=1, const bool show_all_tests=false, const bool dump_all=false)
 Default constructor which sets default parameter values.
bool checkMultiVector (const VectorSpaceBase< Scalar > &vs, const Ptr< Teuchos::FancyOStream > &out) const
 Check a multi-vector as created by a VectorSpaceBase object.
bool check (const MultiVectorBase< Scalar > &mv, const Ptr< Teuchos::FancyOStream > &out) const
 Check a multi-vector object in a set of comprehensive teats.

Detailed Description

template<class Scalar>
class Thyra::MultiVectorTester< Scalar >

Unit testing class for a MultiVectorBase object.

ToDo: Finish documentation!

Definition at line 47 of file Thyra_MultiVectorTester_decl.hpp.


Member Typedef Documentation

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

Local typedef for scalar magnitude.

Definition at line 51 of file Thyra_MultiVectorTester_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::MultiVectorTester< Scalar >::MultiVectorTester ( const ScalarMag  warning_tol = 1e-13,
const ScalarMag  error_tol = 1e-10,
const int  num_random_vectors = 1,
const bool  show_all_tests = false,
const bool  dump_all = false 
)

Default constructor which sets default parameter values.

Note: It is not recommended that the client pass in values in this constructor since the argument list may change in the near future but instead use the above set functions to change an option after construction.

Postconditions:

Definition at line 44 of file Thyra_MultiVectorTester_def.hpp.


Member Function Documentation

template<class Scalar>
LinearOpTester< Scalar > & Thyra::MultiVectorTester< Scalar >::linearOpTester (  )  [inline]

Expose a non-const reference to the LinearOpTester object used to test the LinearOpBase interface supported by MultiVectorBase.

Clients can use this interface to override options directly set on *this.

Definition at line 227 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
const LinearOpTester< Scalar > & Thyra::MultiVectorTester< Scalar >::linearOpTester (  )  const [inline]

Expose a const reference to the LinearOpTester object used to test the LinearOpBase interface supported by MultiVectorBase.

Clients can use this interface to query (but not change) options.

Definition at line 235 of file Thyra_MultiVectorTester_decl.hpp.

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

Set the tolerance above which a relative error will generate a warning message.

Also calls this->linearOpTester().set_all_warning_tol(warning_tol).

Definition at line 243 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
MultiVectorTester< Scalar >::ScalarMag Thyra::MultiVectorTester< Scalar >::warning_tol (  )  const [inline]

Return the warning tolerance for *this.

Definition at line 253 of file Thyra_MultiVectorTester_decl.hpp.

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

Set the error above which a relative error will generate a an message and cause the test to fail.

Also calls this->linearOpTester().set_all_error_tol(error_tol).

Definition at line 261 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
MultiVectorTester< Scalar >::ScalarMag Thyra::MultiVectorTester< Scalar >::error_tol (  )  const [inline]

Return the error tolerance for *this.

Definition at line 271 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
void Thyra::MultiVectorTester< Scalar >::num_random_vectors ( const int  num_random_vectors  )  [inline]

Set the number random vectors that is generated during each test.

Also calls this->linearOpTester().num_random_vectors(num_random_vectors).

Definition at line 279 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
int Thyra::MultiVectorTester< Scalar >::num_random_vectors (  )  const [inline]

Return the number of random vectors used for *this objects tests.

Definition at line 288 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
void Thyra::MultiVectorTester< Scalar >::show_all_tests ( const bool  show_all_tests  )  [inline]

Set whether all of the tests will be printed independent if they pass or fail.

Also calls this->linearOpTester().show_all_tests(show_all_tests).

Definition at line 296 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
bool Thyra::MultiVectorTester< Scalar >::show_all_tests (  )  const [inline]

Return the number of random vectors used for *this objects tests.

Definition at line 305 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
void Thyra::MultiVectorTester< Scalar >::dump_all ( const bool  dump_all  )  [inline]

Set whether all of the vectors and multi-vectors will be dumped or not.

Also calls this->linearOpTester().dump_all(dump_all).

Definition at line 313 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
bool Thyra::MultiVectorTester< Scalar >::dump_all (  )  const [inline]

Return the number of random vectors used for *this objects tests.

Definition at line 322 of file Thyra_MultiVectorTester_decl.hpp.

template<class Scalar>
bool Thyra::MultiVectorTester< Scalar >::checkMultiVector ( const VectorSpaceBase< Scalar > &  vs,
const Ptr< Teuchos::FancyOStream > &  out 
) const

Check a multi-vector as created by a VectorSpaceBase object.

Definition at line 60 of file Thyra_MultiVectorTester_def.hpp.

template<class Scalar>
bool Thyra::MultiVectorTester< Scalar >::check ( const MultiVectorBase< Scalar > &  mv,
const Ptr< Teuchos::FancyOStream > &  out 
) const

Check a multi-vector object in a set of comprehensive teats.

Parameters:
mv [in] The multi-vector object to test.
out [in/out] If out != NULL then output will be sent to *out.
The behavior of this function greatly depends on a number of options (see MultiVectorTester() for the default values for these options):

Returns:
The function returns true if all of the tests where within the error_tol() and returns false if not.
The best way to see what this testing function is doing is to run the test with out!=NULL and to look at the implementation by clicking on the following link to the source code:

Definition at line 170 of file Thyra_MultiVectorTester_def.hpp.

template<class Scalar>
THYRA_DEPRECATED bool Thyra::MultiVectorTester< Scalar >::check ( const MultiVectorBase< Scalar > &  mv,
Teuchos::FancyOStream out 
) const [inline]

Deprecated.

Definition at line 197 of file Thyra_MultiVectorTester_decl.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:26:36 2010 for Thyra by  doxygen 1.4.7