Thyra Version of the Day
Public Types | Public Member Functions
Thyra::LinearOpTester< Scalar > Class Template Reference

Testing class for LinearOpBase. More...

#include <Thyra_LinearOpTester_decl.hpp>

List of all members.

Public Types

typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 
ScalarMag
 Local typedef for promoted scalar magnitude.

Public Member Functions

 LinearOpTester ()
 Default constructor which sets default parameter values.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_linear_properties)
 Set if to check for linear properties alpha*op*(x + y) == op(alpha*x) + op(alpha*y)
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, linear_properties_warning_tol)
 Set the tolerance above which a relative error will generate a warning message for the check of the linear properties.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, linear_properties_error_tol)
 Set the tolerance above which a relative error will generate a error message and result in test failure for the check of the linear properties.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_adjoint)
 Set if to check for adjoint property x'*(op*y) == y'*(op'*x) if adjoint is supported.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_warning_tol)
 Set the tolerance above which a relative error will generate a warning message for the check of the adjoint.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, adjoint_error_tol)
 Set the tolerance above which a relative error will generate a error message and result in test failure for the check of the adjoint.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_for_symmetry)
 Set if to check for symmetry property x'*(op*y) == y'*(op*x) for symmetric operators.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, symmetry_warning_tol)
 Set the tolerance above which a relative error will generate a warning message for the check of symmetry.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (ScalarMag, symmetry_error_tol)
 Set the tolerance above which a relative error will generate a error message and result in test failure for the check of symmetry.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (int, num_random_vectors)
 Set the number random vectors that is generated during each test.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, show_all_tests)
 Set if all tests are shown or just summaries.
 STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, dump_all)
 Set if all of the vectors are dumped or not (only relevant if show_all_tests()==true).
 STANDARD_MEMBER_COMPOSITION_MEMBERS (int, num_rhs)
 Set the number of right-hand-sides in the multivectors.
void enable_all_tests (const bool enable_all_tests)
 Enable or disable all tests.
void set_all_warning_tol (const ScalarMag warning_tol)
 Set all the warning tolerances to the same value.
void set_all_error_tol (const ScalarMag error_tol)
 Set all the error tolerances to the same value.
bool check (const LinearOpBase< Scalar > &op, const Ptr< MultiVectorRandomizerBase< Scalar > > &rangeRandomizer, const Ptr< MultiVectorRandomizerBase< Scalar > > &domainRandomizer, const Ptr< FancyOStream > &out) const
 Check a linear operator.
bool check (const LinearOpBase< Scalar > &op, const Ptr< FancyOStream > &out) const
 Calls this->check(op,null,null,out,leadingIndent,indentSpacer)
bool compare (const LinearOpBase< Scalar > &op1, const LinearOpBase< Scalar > &op2, const Ptr< MultiVectorRandomizerBase< Scalar > > &domainRandomizer, const Ptr< FancyOStream > &out_arg) const
 Check if two linear operators are the same or not.
bool compare (const LinearOpBase< Scalar > &op1, const LinearOpBase< Scalar > &op2, const Ptr< FancyOStream > &out_arg) const
 Calls this->compare(op1,op2,NULL,out,leadingIndent,indentSpacer).
THYRA_DEPRECATED bool check (const LinearOpBase< Scalar > &op, MultiVectorRandomizerBase< Scalar > *rangeRandomizer, MultiVectorRandomizerBase< Scalar > *domainRandomizer, FancyOStream *out) const
THYRA_DEPRECATED bool check (const LinearOpBase< Scalar > &op, FancyOStream *out) const
 Deprecated.
THYRA_DEPRECATED bool compare (const LinearOpBase< Scalar > &op1, const LinearOpBase< Scalar > &op2, MultiVectorRandomizerBase< Scalar > *domainRandomizer, FancyOStream *out_arg) const
 Deprecated.
THYRA_DEPRECATED bool compare (const LinearOpBase< Scalar > &op1, const LinearOpBase< Scalar > &op2, FancyOStream *out_arg) const
 Deprecated.

Detailed Description

template<class Scalar>
class Thyra::LinearOpTester< Scalar >

Testing class for LinearOpBase.

This testing class performs many different tests just given a LinearOpBase object using the function check().

This testing class also can check if two linear operators are the same using random vectors by using the function compare().

ToDo: Finish documentation!

The default compiler-generated copy constructor and assignment operators are allowed since they have the correct semantics which are to simply copy control parameters.

Definition at line 75 of file Thyra_LinearOpTester_decl.hpp.


Member Typedef Documentation

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

Local typedef for promoted scalar magnitude.

Definition at line 79 of file Thyra_LinearOpTester_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::LinearOpTester< Scalar >::LinearOpTester ( )

Default constructor which sets default parameter values.

See the implementation of this function for the defaults that get set.

Definition at line 154 of file Thyra_LinearOpTester_def.hpp.


Member Function Documentation

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_linear_properties   
)

Set if to check for linear properties alpha*op*(x + y) == op(alpha*x) + op(alpha*y)

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
linear_properties_warning_tol   
)

Set the tolerance above which a relative error will generate a warning message for the check of the linear properties.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
linear_properties_error_tol   
)

Set the tolerance above which a relative error will generate a error message and result in test failure for the check of the linear properties.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_adjoint   
)

Set if to check for adjoint property x'*(op*y) == y'*(op'*x) if adjoint is supported.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_warning_tol   
)

Set the tolerance above which a relative error will generate a warning message for the check of the adjoint.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
adjoint_error_tol   
)

Set the tolerance above which a relative error will generate a error message and result in test failure for the check of the adjoint.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
check_for_symmetry   
)

Set if to check for symmetry property x'*(op*y) == y'*(op*x) for symmetric operators.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
symmetry_warning_tol   
)

Set the tolerance above which a relative error will generate a warning message for the check of symmetry.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( ScalarMag  ,
symmetry_error_tol   
)

Set the tolerance above which a relative error will generate a error message and result in test failure for the check of symmetry.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( int  ,
num_random_vectors   
)

Set the number random vectors that is generated during each test.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
show_all_tests   
)

Set if all tests are shown or just summaries.

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( bool  ,
dump_all   
)

Set if all of the vectors are dumped or not (only relevant if show_all_tests()==true).

template<class Scalar>
Thyra::LinearOpTester< Scalar >::STANDARD_MEMBER_COMPOSITION_MEMBERS ( int  ,
num_rhs   
)

Set the number of right-hand-sides in the multivectors.

template<class Scalar >
void Thyra::LinearOpTester< Scalar >::enable_all_tests ( const bool  enable_all_tests)

Enable or disable all tests.

Postconditions:

  • this->check_linear_properties()==enable_all_tests
  • this->check_adjoint()==enable_all_tests
  • this->check_for_symmetry()==enable_all_tests

Definition at line 174 of file Thyra_LinearOpTester_def.hpp.

template<class Scalar >
void Thyra::LinearOpTester< Scalar >::set_all_warning_tol ( const ScalarMag  warning_tol)

Set all the warning tolerances to the same value.

Postconditions:

  • this->linear_properties_warning_tol()==warning_tol
  • this->adjoint_warning_tol()==warning_tol
  • this->symmetry_warning_tol()==warning_tol

Definition at line 183 of file Thyra_LinearOpTester_def.hpp.

template<class Scalar >
void Thyra::LinearOpTester< Scalar >::set_all_error_tol ( const ScalarMag  error_tol)

Set all the error tolerances to the same value.

Postconditions:

  • this->linear_properties_error_tol()==error_tol
  • this->adjoint_error_tol()==error_tol
  • this->symmetry_error_tol()==error_tol

Definition at line 192 of file Thyra_LinearOpTester_def.hpp.

template<class Scalar>
bool Thyra::LinearOpTester< Scalar >::check ( const LinearOpBase< Scalar > &  op,
const Ptr< MultiVectorRandomizerBase< Scalar > > &  rangeRandomizer,
const Ptr< MultiVectorRandomizerBase< Scalar > > &  domainRandomizer,
const Ptr< FancyOStream > &  out 
) const

Check a linear operator.

Parameters:
op[in] The linear operator to check.
out[in/out] If out!=NULL then trace output about the tests performed will be sent to *out.
rangeRandomizer[in] Randomizer strategy object for creating random vectors in the range of the operator op. If NULL then UniveralMultiVectorRandomizer is used intead.
domainRandomizer[in] Randomizer strategy object for creating random vectors in the domain of the operator op. If NULL then UniveralMultiVectorRandomizer is used intead.

Preconditions:

  • [rangeRandomizer!=NULL] rangeRandomizer->isCompatible(*op.range())==true
  • [domainRandomizer!=NULL] domainRandomizer->isCompatible(*op.domain())==true

This function performs a number of tests on op:

  • Checks that the domain and range spaces are valid.

  • Creates temporary vectors using the domain and range spaces.

  • If this->check_linear_properties()==true then checks that $\alpha A ( u + v ) = \alpha A u + \alpha A v$ to a relative tolerance defined by error_tol(). Note, if the client wants to check the linear properties of the adjoint then the client should first create an implicit adjoint using adjoint() (or transpose using transpose()) which wraps the operation in a DefaultScaledAdjointLinearOp. Using this method a client can check all the various values of the enum EOpTransp.

  • If this->check_adjoint()==true then, checks that the non-transposed operator and the adjoint operator agree. The operator and adjoint operator must obey the defined scalar product. Specifically, for any two vectors $w$ (in the domain space $\mathcal{D}$) and $u$ (in the range space $\mathcal{R}$), the adjoint operation must obey:

    \[<u,A v>_{\mathcal{R}} = <A^H u, v>_{\mathcal{D}}\]

    where $<.,.>_{\mathcal{R}}$ is the scalar product defined by op.range()->scalarProd() and $<.,.>_{\mathcal{D}}$ is the scalar product defined by op.domain()->scalarProd().

  • If this->check_for_symmetry()==true the the operator will be checked to see if it is symmetric. Specifically, for any two random vectors $w$ and $u$ in the operator's space $\mathcal{S}$, the following property is checked:

    \[<u,A v>_{\mathcal{S}} = <A u, v>_{\mathcal{S}}\]

    where $<.,.>_{\mathcal{S}}$ is the scalar product defined by op.domain()->scalarProd() and op.domain()->scalarProd().

All relative errors that exceed xxx_warning_tol() but do not exceed xxx_error_tol will result in special warning messages printed to *out (if out!=NULL).

Returns:
The function returns true if all of the tests where within the xxx_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:

template<class Scalar>
bool Thyra::LinearOpTester< Scalar >::check ( const LinearOpBase< Scalar > &  op,
const Ptr< FancyOStream > &  out 
) const

Calls this->check(op,null,null,out,leadingIndent,indentSpacer)

template<class Scalar>
bool Thyra::LinearOpTester< Scalar >::compare ( const LinearOpBase< Scalar > &  op1,
const LinearOpBase< Scalar > &  op2,
const Ptr< MultiVectorRandomizerBase< Scalar > > &  domainRandomizer,
const Ptr< FancyOStream > &  out_arg 
) const

Check if two linear operators are the same or not.

Parameters:
op1[in] The first linear operator
op2[in] The second linear operator
domainRandomizer[in] Randomizer strategy object for creating random vectors in the domain of the operator op. If NULL then UniveralMultiVectorRandomizer is used intead.
out[in/out] If out!=NULL then trace output about the tests performed 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 will use this indentation. Default value " ".

This function checks if op1 and op2 are the same by checking that the range and domain spaces are compatible and then checking that sum(op1*v) == sum(op2*v) for various random vectors. The allowed warning and error tolerances are taken from linear_properties_warning_tol() and linear_properties_error_tol().

All relative errors that exceed xxx_warning_tol() but do not exceed xxx_error_tol will result in special warning messages printed to *out (if out!=NULL).

Returns:
The function returns true if all of the tests where within the xxx_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:

template<class Scalar>
bool Thyra::LinearOpTester< Scalar >::compare ( const LinearOpBase< Scalar > &  op1,
const LinearOpBase< Scalar > &  op2,
const Ptr< FancyOStream > &  out_arg 
) const

Calls this->compare(op1,op2,NULL,out,leadingIndent,indentSpacer).

template<class Scalar>
THYRA_DEPRECATED bool Thyra::LinearOpTester< Scalar >::check ( const LinearOpBase< Scalar > &  op,
MultiVectorRandomizerBase< Scalar > *  rangeRandomizer,
MultiVectorRandomizerBase< Scalar > *  domainRandomizer,
FancyOStream out 
) const [inline]

Deprecated.

Definition at line 320 of file Thyra_LinearOpTester_decl.hpp.

template<class Scalar>
THYRA_DEPRECATED bool Thyra::LinearOpTester< Scalar >::check ( const LinearOpBase< Scalar > &  op,
FancyOStream out 
) const [inline]

Deprecated.

Definition at line 332 of file Thyra_LinearOpTester_decl.hpp.

template<class Scalar>
THYRA_DEPRECATED bool Thyra::LinearOpTester< Scalar >::compare ( const LinearOpBase< Scalar > &  op1,
const LinearOpBase< Scalar > &  op2,
MultiVectorRandomizerBase< Scalar > *  domainRandomizer,
FancyOStream out_arg 
) const [inline]

Deprecated.

Definition at line 341 of file Thyra_LinearOpTester_decl.hpp.

template<class Scalar>
THYRA_DEPRECATED bool Thyra::LinearOpTester< Scalar >::compare ( const LinearOpBase< Scalar > &  op1,
const LinearOpBase< Scalar > &  op2,
FancyOStream out_arg 
) const [inline]

Deprecated.

Definition at line 353 of file Thyra_LinearOpTester_decl.hpp.


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