Thyra_VectorTester_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_TESTER_DECL_HPP
#define THYRA_VECTOR_TESTER_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_MultiVectorTester.hpp"

namespace Thyra {

template<class Scalar>
class VectorTester {
public:

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

  MultiVectorTester<Scalar>& multiVectorTester();

  const MultiVectorTester<Scalar>& multiVectorTester() 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;

  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;

  VectorTester(
    const ScalarMag     warning_tol            = 1e-13
    ,const ScalarMag    error_tol              = 1e-10
    ,const int          num_random_vectors     = 1
    ,const bool         show_all_tests         = false
    ,const bool         dump_all               = false
    );

  bool check(
    const VectorBase<Scalar>       &v
    ,Teuchos::FancyOStream         *out
    ) const;

private:

  MultiVectorTester<Scalar> multiVectorTester_;

  ScalarMag    warning_tol_;
  ScalarMag    error_tol_;
  int          num_random_vectors_;
  bool         show_all_tests_;
  bool         dump_all_;

}; // class VectorTester

// //////////////////////////////////
// Inline members

template<class Scalar>
inline
MultiVectorTester<Scalar>& VectorTester<Scalar>::multiVectorTester()
{
  return multiVectorTester_;
}

template<class Scalar>
inline
const MultiVectorTester<Scalar>& VectorTester<Scalar>::multiVectorTester() const
{
  return multiVectorTester_;
}

template<class Scalar>
inline
void VectorTester<Scalar>::warning_tol( const ScalarMag &warning_tol_in )
{
  warning_tol_ = warning_tol_in;
  multiVectorTester_.warning_tol(warning_tol_in);
}

template<class Scalar>
inline
typename VectorTester<Scalar>::ScalarMag
VectorTester<Scalar>::warning_tol() const
{
  return warning_tol_;
}

template<class Scalar>
inline
void VectorTester<Scalar>::error_tol( const ScalarMag &error_tol_in )
{
  error_tol_ = error_tol_in;
  multiVectorTester_.error_tol(error_tol_in);
}

template<class Scalar>
inline
typename VectorTester<Scalar>::ScalarMag
VectorTester<Scalar>::error_tol() const
{
  return error_tol_;
}

template<class Scalar>
inline
void VectorTester<Scalar>::num_random_vectors( const int num_random_vectors_in )
{
  num_random_vectors_ = num_random_vectors_in;
  multiVectorTester_.num_random_vectors(num_random_vectors_in);
}

template<class Scalar>
inline
int VectorTester<Scalar>::num_random_vectors() const
{
  return num_random_vectors_;
}

template<class Scalar>
inline
void VectorTester<Scalar>::show_all_tests( const bool show_all_tests_in )
{
  show_all_tests_ = show_all_tests_in;
  multiVectorTester_.show_all_tests(show_all_tests_in);
}

template<class Scalar>
inline
bool VectorTester<Scalar>::show_all_tests() const
{
  return show_all_tests_;
}

template<class Scalar>
inline
void VectorTester<Scalar>::dump_all( const bool dump_all_in )
{
  dump_all_ = dump_all_in;
  multiVectorTester_.dump_all(dump_all_in);
}

template<class Scalar>
inline
bool VectorTester<Scalar>::dump_all() const
{
  return dump_all_;
}

} // namespace Thyra

#endif // THYRA_VECTOR_TESTER_DECL_HPP