Thyra_TesterBase.hpp

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER


#ifndef THYRA_TESTERBASE_HPP
#define THYRA_TESTERBASE_HPP

#include "Thyra_LinearOperatorImpl.hpp"
#include "Thyra_TestSpecifier.hpp"
#include "Teuchos_ScalarTraits.hpp"
#include "Teuchos_Comm.hpp"
#include "Teuchos_CommHelpers.hpp"


namespace Thyra {

template <class Scalar>
class TesterBase 
{
public:
  typedef typename ScalarTraits<Scalar>::magnitudeType ScalarMag;

  TesterBase(const RCP<const Comm<int> >& comm,
    const VectorSpace<Scalar>& space, int nCols,
    Teuchos::RCP<Teuchos::FancyOStream>& out)
    : comm_(comm), space_(space), nCols_(nCols), out_(out) 
    {
      using std::endl;
      *out << "==========================================================================="
           << endl;
      *out << "       testing on type " 
           << Teuchos::ScalarTraits<Scalar>::name() << endl;
      *out << "==========================================================================="
           << endl;
    }

  virtual ~TesterBase(){;}

  virtual bool runAllTests() const = 0 ;


  bool checkTest(const TestSpecifier<Scalar>& spec,
    const ScalarMag& err, 
    const string& testName) const ;

  void randomizeVec(Vector<Scalar>& x) const ;

  LinearOperator<Scalar> randomDenseOp() const ;

  const VectorSpace<Scalar>& space() const {return space_;}

  ostream& out() const {return *out_;}

  const Comm<int>& comm() const {return *comm_;}
    
private:
  RCP<const Comm<int> > comm_;
  VectorSpace<Scalar> space_;
  int nCols_;
  mutable Teuchos::RCP<Teuchos::FancyOStream> out_;
};


template <class Scalar> 
inline void TesterBase<Scalar>
::randomizeVec(Vector<Scalar>& x) const
{
  typedef ScalarTraits<Scalar> ST;
  randomize(Scalar(-ST::one()),Scalar(+ST::one()),x.ptr().get());
    
}


template <class Scalar> 
inline bool TesterBase<Scalar>
::checkTest(const TestSpecifier<Scalar>& spec,
  const ScalarMag& err, 
  const string& testName) const 
{
    
  using std::endl;

  bool rtn = true;
  if (err > spec.errorTol())
  {
    *out_ << testName << " test FAILED: err=" << err << ", tol = " 
          << spec.errorTol() << endl;
    rtn = false;
  }
  else if (err > spec.warningTol())
  {
    *out_ << "WARNING: " << testName << " test err="
          << err << " could not beat tol = " 
          << spec.warningTol() << endl;
  }
  else
  {
    *out_ << "test " << testName << " PASSED with tol=" << spec.errorTol() << endl;
  }
  return rtn;
}


template <class Scalar>
inline LinearOperator<Scalar> TesterBase<Scalar>
::randomDenseOp() const 
{
  typedef ScalarTraits<Scalar> ST;
  RCP<MultiVectorBase<Scalar> > mv = space_.createMembers(nCols_);
  randomize(-ST::one(), ST::one(), &*mv);
  RCP<LinearOpBase<Scalar> > rtn = mv;
  return rtn;
}
 
 
} // namespace Thyra


#endif // THYRA_TESTERBASE_HPP

---