Thyra_TestingToolsDecl.hpp File Reference

#include "Thyra_OperatorVectorTypes.hpp"

Include dependency graph for Thyra_TestingToolsDecl.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	Thyra
Functions
const char *	passfail (bool pass)
	Return "passed" or "failed".
template<class Scalar>
Teuchos::ScalarTraits< Scalar >::magnitudeType	relErr (const Scalar &s1, const Scalar &s2)
	Return relative error of two scalars.
template<class Scalar>
bool	testRelErr (const std::string &v1_name, const Scalar &v1, const std::string &v2_name, const Scalar &v2, const std::string &maxRelErr_error_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &maxRelErr_error, const std::string &maxRelErr_warning_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &maxRelErr_warning, std::ostream *out, const std::string &leadingIndent=std::string(""))
	Compute, check and optionally print the relative error in two scalars.
template<class Scalar1, class Scalar2, class ScalarMag>
bool	testRelErrors (const int num_scalars, const std::string &v1_name, const Scalar1 v1[], const std::string &v2_name, const Scalar2 v2[], const std::string &maxRelErr_error_name, const ScalarMag &maxRelErr_error, const std::string &maxRelErr_warning_name, const ScalarMag &maxRelErr_warning, std::ostream *out, const std::string &leadingIndent=std::string(""))
	Compute, check and optionally print the relative errors in two scalar arays.
template<class Scalar>
bool	testMaxErr (const std::string &error_name, const Scalar &error, const std::string &max_error_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &max_error, const std::string &max_warning_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &max_warning, std::ostream *out, const std::string &leadingIndent=std::string(""))
	Check that an error is less than some error tolerence.
template<class Scalar>
bool	testMaxErrors (const int num_scalars, const std::string &error_name, const Scalar error[], const std::string &max_error_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &max_error, const std::string &max_warning_name, const typename Teuchos::ScalarTraits< Scalar >::magnitudeType &max_warning, std::ostream *out, const std::string &leadingIndent=std::string(""))
	Check that an array of errors is less than some error tolerence.
bool	testBoolExpr (const std::string &boolExprName, const bool &boolExpr, const bool &boolExpected, std::ostream *out, const std::string &leadingIndent=std::string(""))
	Check a boolean result against expected result.
void	printTestResults (const bool result, const std::string &test_summary, const bool show_all_tests, bool *success, std::ostream *out)
	Print summary outputting for a test or just passed or failed.
template<class Scalar>
std::ostream &	operator<< (std::ostream &o, const VectorBase< Scalar > &v)
	Output operator to pretty print any Thyra::VectorBase object.
template<class Scalar>
std::ostream &	operator<< (std::ostream &o, const LinearOpBase< Scalar > &M)
	Output operator to pretty print any Thyra::LinearOpBase object.

---

Function Documentation

void Thyra::printTestResults (  const bool  result, const std::string &  test_summary, const bool  show_all_tests, bool *  success, std::ostream *  out )  [inline]

Print summary outputting for a test or just passed or failed. Parameters: result  [in] Bool for of the test was successful or unsuccessful. test_summary  [in] The summary of the test that was just completed. show_all_tests  [in] Bool for if the test summary should be shown even if the test passed. success  [out] Update of the success bool. out  [out] Stream where output will be sent if *out!=NULL. Preconditions: success!=NULL Preconditions: *success==false if result==false Just look at the definition of this function to see what it does. Definition at line 212 of file Thyra_TestingToolsDecl.hpp.

---