Vector Interfaces as an API for the Development of Abstract Numerical Algorithms (ANAs)]

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

#include <Thyra_VectorTesterDecl.hpp>

List of all members.

Public Types

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

Local typedef for scalar magnitude.

Public Member Functions

MultiVectorTester< Scalar > & multiVectorTester ()

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

const MultiVectorTester< Scalar > & multiVectorTester () const

Expose a const reference to the MultiVectorTester object used to test the MultiVectorBase interface supported by VectorBase.

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.

VectorTester (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 check (const VectorBase< Scalar > &v, std::ostream *out, const std::string &leadingIndent="", const std::string &indentSpacer=" ") const

Check a vector object in a set of comprehensive tests.

Detailed Description

template<class Scalar>
class Thyra::VectorTester< Scalar >

Unit testing class for a VectorBase object.

ToDo: Finish documentation!

Definition at line 44 of file Thyra_VectorTesterDecl.hpp.

Member Typedef Documentation

template<class Scalar>

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

Local typedef for scalar magnitude.

Definition at line 48 of file Thyra_VectorTesterDecl.hpp.

Constructor & Destructor Documentation

template<class Scalar>

Thyra::VectorTester< Scalar >::VectorTester ( 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:

this->warning_tol() == warning_tol

this->error_tol() == error_tol

this->num_random_vectors() == num_random_vectors

this->show_all_tests() == show_all_tests

this->dump_all() == dump_all

Calls this->multiVectorTester().set_all_warning_tol(warning_tol)

Calls this->multiVectorTester().set_all_error_tol(error_tol)

Calls this->multiVectorTester().num_random_vectors(num_random_vectors)

Calls this->multiVectorTester().show_all_tests(show_all_tests)

Calls this->multiVectorTester().dump_all(dump_all)

Definition at line 37 of file Thyra_VectorTester.hpp.

Member Function Documentation

template<class Scalar>

MultiVectorTester< Scalar > & Thyra::VectorTester< Scalar >::multiVectorTester ( ) [inline]

Expose a non-const reference to the MultiVectorTester object used to test the MultiVectorBase interface supported by VectorBase.
Clients can use this interface to override options directly set on *this.
Definition at line 209 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

const MultiVectorTester< Scalar > & Thyra::VectorTester< Scalar >::multiVectorTester ( ) const [inline]

Expose a const reference to the MultiVectorTester object used to test the MultiVectorBase interface supported by VectorBase.
Clients can use this interface to query (but not change) options.
Definition at line 216 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

void Thyra::VectorTester< Scalar >::warning_tol ( const ScalarMag & warning_tol ) [inline]

Set the tolerance above which a relative error will generate a warning message.
Also calls this->multiVectorTester().set_all_warning_tol(warning_tol).
Definition at line 223 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

VectorTester< Scalar >::ScalarMag Thyra::VectorTester< Scalar >::warning_tol ( ) const [inline]

Return the warning tolerance for *this.

Definition at line 232 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

void Thyra::VectorTester< 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->multiVectorTester().set_all_error_tol(error_tol).
Definition at line 239 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

VectorTester< Scalar >::ScalarMag Thyra::VectorTester< Scalar >::error_tol ( ) const [inline]

Return the error tolerance for *this.

Definition at line 248 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

void Thyra::VectorTester< Scalar >::num_random_vectors ( const int num_random_vectors ) [inline]

Set the number random vectors that is generated during each test.
Also calls this->multiVectorTester().num_random_vectors(num_random_vectors).
Definition at line 255 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

int Thyra::VectorTester< Scalar >::num_random_vectors ( ) const [inline]

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

Definition at line 263 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

void Thyra::VectorTester< 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->multiVectorTester().show_all_tests(show_all_tests).
Definition at line 270 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

bool Thyra::VectorTester< Scalar >::show_all_tests ( ) const [inline]

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

Definition at line 278 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

void Thyra::VectorTester< 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->multiVectorTester().dump_all(dump_all).
Definition at line 285 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

bool Thyra::VectorTester< Scalar >::dump_all ( ) const [inline]

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

Definition at line 293 of file Thyra_VectorTesterDecl.hpp.

template<class Scalar>

bool Thyra::VectorTester< Scalar >::check ( const VectorBase< Scalar > & v,

std::ostream * out,

const std::string & leadingIndent = "",

const std::string & indentSpacer = " "

) const

Check a vector object in a set of comprehensive tests.

Parameters:

v [in] The vector object to test.

out [in/out] If out != NULL then output will be sent to *out.

leadingIndent [in] All output to *out will insert this spacer before each new line is printed. Default value "".

indentSpacer [in] All output to *out that is further indented 8 will use this indentation. Default value " ".

The behavior of this function greatly depends on a number of options (see VectorTester() for the default values for these options):

print_all_tests(bool): If print_all_tests() == true, then some output will be sent to *out for every test performed. This is useful to see all of tests that are performed and in debugging.

dump_all(bool): If dump_all() == true, then all of the vectors will be printed that are created during the tests. This option is really only needed during initial debugging and should only be used with small vector spaces since it will produce a lot of O(space.dim()) output.

num_random_tests(int): This is the number of random tests to perform per category of test. A higher number will result is better validation but will consume more CPU time.

warning_tol(ScalarMag): Any test with a relative error greater than warning_tol() will result in a warning message printed to *out but will not result in a filed test.

error_tol(Scalar): Any test with a relative error greater than error_tol() will result in an error message printed to *out and will result in a failed test.

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 58 of file Thyra_VectorTester.hpp.

The documentation for this class was generated from the following files:

Generated on Thu Sep 18 12:39:55 2008 for Thyra ANA Operator/VectorBase Interfaces and Related Software by

1.3.9.1


Public Types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	ScalarMag
	Local typedef for scalar magnitude.
Public Member Functions
MultiVectorTester< Scalar > &	multiVectorTester ()
	Expose a non-`const` reference to the `MultiVectorTester` object used to test the `MultiVectorBase` interface supported by `VectorBase`.
const MultiVectorTester< Scalar > &	multiVectorTester () const
	Expose a `const` reference to the `MultiVectorTester` object used to test the `MultiVectorBase` interface supported by `VectorBase`.
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.
	VectorTester (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	check (const VectorBase< Scalar > &v, std::ostream *out, const std::string &leadingIndent="", const std::string &indentSpacer=" ") const
	Check a vector object in a set of comprehensive tests.

Thyra::VectorTester< Scalar > Class Template Reference [Thyra Operator/Vector Interfaces as an API for the Development of Abstract Numerical Algorithms (ANAs)]

Public Types