Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Static Public Member Functions | List of all members
Teuchos::TestRelErr< T1, T2, Enabled > Struct Template Reference

Compute, check and optionally print the relative error in two scalars. More...

#include <Teuchos_TestingHelpers.hpp>

Public Types

typedef Teuchos::ScalarTraits
< T1 >::magnitudeType 		magType1
 
typedef Teuchos::ScalarTraits
< T2 >::magnitudeType 		magType2
 
typedef std::common_type
< magType1, magType2 >::type 		magnitudeType
 

Static Public Member Functions

static bool eval (const std::string &v1_name, const T1 &v1, const std::string &v2_name, const T2 &v2, const std::string &maxRelErr_error_name, const magnitudeType &maxRelErr_error, const std::string &maxRelErr_warning_name, const magnitudeType &maxRelErr_warning, const Ptr< std::ostream > &out)
 

Detailed Description

template<typename T1, typename T2, typename Enabled = void>
struct Teuchos::TestRelErr< T1, T2, Enabled >

Compute, check and optionally print the relative error in two scalars.

ToDo: Finish documentation!

Definition at line 166 of file Teuchos_TestingHelpers.hpp.

Member Typedef Documentation

template<typename T1, typename T2, typename Enabled = void>
typedef Teuchos::ScalarTraits<T1>::magnitudeType Teuchos::TestRelErr< T1, T2, Enabled >::magType1

Definition at line 167 of file Teuchos_TestingHelpers.hpp.

template<typename T1, typename T2, typename Enabled = void>
typedef Teuchos::ScalarTraits<T2>::magnitudeType Teuchos::TestRelErr< T1, T2, Enabled >::magType2

Definition at line 168 of file Teuchos_TestingHelpers.hpp.

template<typename T1, typename T2, typename Enabled = void>
typedef std::common_type<magType1,magType2>::type Teuchos::TestRelErr< T1, T2, Enabled >::magnitudeType

Definition at line 169 of file Teuchos_TestingHelpers.hpp.

Member Function Documentation

template<typename T1, typename T2, typename Enabled = void>
static bool Teuchos::TestRelErr< T1, T2, Enabled >::eval ( const std::string &  v1_name,
const T1 &  v1,
const std::string &  v2_name,
const T2 &  v2,
const std::string &  maxRelErr_error_name,
const magnitudeType &  maxRelErr_error,
const std::string &  maxRelErr_warning_name,
const magnitudeType &  maxRelErr_warning,
const Ptr< std::ostream > &  out 
)
inlinestatic

Definition at line 170 of file Teuchos_TestingHelpers.hpp.

The documentation for this struct was generated from the following file:
Generated on Wed Apr 24 2024 09:22:39 for Teuchos Package Browser (Single Doxygen Collection) by   doxygen 1.8.5