Thyra Package Browser (Single Doxygen Collection) Version of the Day
Public Types | Public Member Functions
Thyra::VectorStdOpsTester< Scalar > Class Template Reference

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

#include <Thyra_VectorStdOpsTester_decl.hpp>

List of all members.

Public Types

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

Public Member Functions

 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, warning_tol)
 Set the maximum relative error before a warning is generated.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, error_tol)
 Set the maximum relative error before an error is generated.
 VectorStdOpsTester (const ScalarMag &warning_tol=0, const ScalarMag &error_tol=0)
 
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::VectorStdOpsTester< 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_VectorStdOpsTester_decl.hpp.


Member Typedef Documentation

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

Definition at line 48 of file Thyra_VectorStdOpsTester_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::VectorStdOpsTester< Scalar >::VectorStdOpsTester ( const ScalarMag warning_tol = 0,
const ScalarMag error_tol = 0 
)

Definition at line 226 of file Thyra_VectorStdOpsTester_def.hpp.


Member Function Documentation

template<class Scalar>
Thyra::VectorStdOpsTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
warning_tol   
)

Set the maximum relative error before a warning is generated.

template<class Scalar>
Thyra::VectorStdOpsTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
error_tol   
)

Set the maximum relative error before an error is generated.

template<class Scalar >
bool Thyra::VectorStdOpsTester< 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 236 of file Thyra_VectorStdOpsTester_def.hpp.

References Thyra::abs(), Teuchos::as(), Thyra::assign(), Teuchos::Describable::description(), Thyra::VectorSpaceBase< Scalar >::dim(), Thyra::ele_wise_prod(), Thyra::ele_wise_prod_update(), Thyra::n, Teuchos::null, Teuchos::RCP< T >::ptr(), Thyra::randomize(), Thyra::reciprocal(), Thyra::set_ele(), RTOpPack::show_spmd_apply_op_dump, TEST_FOR_EXCEPTION, TEUCHOS_ASSERT, TEUCHOS_TEST_ASSERT, TEUCHOS_TEST_EQUALITY_CONST, TEUCHOS_TEST_THROW, Thyra::V_S(), Thyra::V_StV(), Thyra::V_StVpStV(), Thyra::V_StVpV(), Thyra::V_V(), Thyra::V_VmV(), Thyra::Vp_StV(), Thyra::Vp_StVtV(), Thyra::Vp_V(), Thyra::Vt_S(), and Thyra::Vt_StV().

Referenced by run_product_space_tests(), and Thyra::run_std_ops_tests().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines