Thyra_VectorSpaceTester_decl.hpp

// @HEADER
// *****************************************************************************
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//
// Copyright 2004 NTESS and the Thyra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef THYRA_VECTOR_SPACE_TESTER_DECL_HPP
#define THYRA_VECTOR_SPACE_TESTER_DECL_HPP
 
#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_VectorTester.hpp"
 
namespace Thyra {
 
 
template<class Scalar>
class VectorSpaceTester {
public:
 
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;
 
  VectorTester<Scalar>& vectorTester();
 
  const VectorTester<Scalar>& vectorTester() const;
 
  void warning_tol( const ScalarMag &warning_tol );
 
  ScalarMag warning_tol() const;
 
  void error_tol( const ScalarMag &error_tol );
 
  ScalarMag error_tol() const;
 
  void num_random_vectors( const int num_random_vectors );
 
  int num_random_vectors() const;
 
  STANDARD_MEMBER_COMPOSITION_MEMBERS( int, num_mv_cols );
 
  void show_all_tests( const bool show_all_tests );
 
  bool show_all_tests() const;
 
  void dump_all( const bool dump_all );
 
  bool dump_all() const;
 
  VectorSpaceTester(
    const ScalarMag     warning_tol            = 1e-13
    ,const ScalarMag    error_tol              = 1e-10
    ,const int          num_random_vectors     = 1
    ,const int          num_mv_cols            = 4
    ,const bool         show_all_tests         = false
    ,const bool         dump_all               = false
    );
 
  bool check(
    const VectorSpaceBase<Scalar> &vs,
    Teuchos::FancyOStream *out
    ) const;
 
private:
 
  VectorTester<Scalar> vectorTester_;
 
  ScalarMag    warning_tol_;
  ScalarMag    error_tol_;
  int          num_random_vectors_;
  bool         show_all_tests_;
  bool         dump_all_;
 
}; // class VectorSpaceTester
 
 
// ///////////////////////////
// Inline members
 
 
template<class Scalar>
inline
VectorTester<Scalar>& VectorSpaceTester<Scalar>::vectorTester()
{
  return vectorTester_;
}
 
 
template<class Scalar>
inline
const VectorTester<Scalar>& VectorSpaceTester<Scalar>::vectorTester() const
{
  return vectorTester_;
}
 
 
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::warning_tol( const ScalarMag &warning_tol_in )
{
  warning_tol_ = warning_tol_in;
  vectorTester_.warning_tol(warning_tol_in);
}
 
 
template<class Scalar>
inline
typename VectorSpaceTester<Scalar>::ScalarMag
VectorSpaceTester<Scalar>::warning_tol() const
{
  return warning_tol_;
}
 
 
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::error_tol( const ScalarMag &error_tol_in )
{
  error_tol_ = error_tol_in;
  vectorTester_.error_tol(error_tol_in);
}
 
 
template<class Scalar>
inline
typename VectorSpaceTester<Scalar>::ScalarMag
VectorSpaceTester<Scalar>::error_tol() const
{
  return error_tol_;
}
 
 
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::num_random_vectors( const int num_random_vectors_in )
{
  num_random_vectors_ = num_random_vectors_in;
  vectorTester_.num_random_vectors(num_random_vectors_in);
}
 
 
template<class Scalar>
inline
int VectorSpaceTester<Scalar>::num_random_vectors() const
{
  return num_random_vectors_;
}
 
 
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::show_all_tests( const bool show_all_tests_in )
{
  show_all_tests_ = show_all_tests_in;
  vectorTester_.show_all_tests(show_all_tests_in);
}
 
 
template<class Scalar>
inline
bool VectorSpaceTester<Scalar>::show_all_tests() const
{
  return show_all_tests_;
}
 
 
template<class Scalar>
inline
void VectorSpaceTester<Scalar>::dump_all( const bool dump_all_in )
{
  dump_all_ = dump_all_in;
  vectorTester_.dump_all(dump_all_in);
}
 
 
template<class Scalar>
inline
bool VectorSpaceTester<Scalar>::dump_all() const
{
  return dump_all_;
}
 
 
} // namespace Thyra
 
 
#endif // THYRA_VECTOR_SPACE_TESTER_DECL_HPP