Thyra Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
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>

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 57 of file Thyra_VectorStdOpsTester_decl.hpp.

Member Typedef Documentation

◆ ScalarMag

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

Definition at line 61 of file Thyra_VectorStdOpsTester_decl.hpp.

Constructor & Destructor Documentation

◆ VectorStdOpsTester()

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

Definition at line 276 of file Thyra_VectorStdOpsTester_def.hpp.

Member Function Documentation

◆ STANDARD_MEMBER_COMPOSITION_MEMBERS() [1/2]

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

Set the maximum relative error before a warning is generated.

◆ STANDARD_MEMBER_COMPOSITION_MEMBERS() [2/2]

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

Set the maximum relative error before an error is generated.

◆ checkStdOps()

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 286 of file Thyra_VectorStdOpsTester_def.hpp.


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