93 lines
3.2 KiB
C++
93 lines
3.2 KiB
C++
// @HEADER
|
|
// ***********************************************************************
|
|
//
|
|
// Anasazi: Block Eigensolvers Package
|
|
// 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 ANASAZI_OPERATOR_TRAITS_HPP
|
|
#define ANASAZI_OPERATOR_TRAITS_HPP
|
|
|
|
/*! \file AnasaziOperatorTraits.hpp
|
|
\brief Virtual base class which defines basic traits for the operator type
|
|
*/
|
|
|
|
#include "AnasaziConfigDefs.hpp"
|
|
#include "AnasaziTypes.hpp"
|
|
|
|
|
|
namespace Anasazi {
|
|
|
|
|
|
//! \brief Exceptions thrown to signal error in operator application.
|
|
class OperatorError : public AnasaziError
|
|
{public: OperatorError(const std::string& what_arg) : AnasaziError(what_arg) {}};
|
|
|
|
|
|
/*! \brief This is the default struct used by OperatorTraits<ScalarType, MV, OP> class to produce a
|
|
compile time error when the specialization does not exist for operator type <tt>OP</tt>.
|
|
*/
|
|
template< class ScalarType, class MV, class OP >
|
|
struct UndefinedOperatorTraits
|
|
{
|
|
//! This function should not compile if there is an attempt to instantiate!
|
|
/*! \note Any attempt to compile this function results in a compile time error. This means
|
|
that the template specialization of Anasazi::OperatorTraits class does not exist for type
|
|
<tt>OP</tt>, or is not complete.
|
|
*/
|
|
static inline void notDefined() { return OP::this_type_is_missing_a_specialization(); };
|
|
};
|
|
|
|
|
|
/*! \brief Virtual base class which defines basic traits for the operator type.
|
|
|
|
An adapter for this traits class must exist for the <tt>MV</tt> and <tt>OP</tt> types.
|
|
If not, this class will produce a compile-time error.
|
|
|
|
\ingroup anasazi_opvec_interfaces
|
|
*/
|
|
template <class ScalarType, class MV, class OP>
|
|
class OperatorTraits
|
|
{
|
|
public:
|
|
|
|
//! @name Operator application method.
|
|
//@{
|
|
|
|
//! Application method which performs operation <b>y = Op*x</b>. An OperatorError exception is thrown if there is an error.
|
|
static void Apply ( const OP& Op,
|
|
const MV& x,
|
|
MV& y )
|
|
{ UndefinedOperatorTraits<ScalarType, MV, OP>::notDefined(); };
|
|
|
|
//@}
|
|
|
|
};
|
|
|
|
} // end Anasazi namespace
|
|
|
|
#endif // ANASAZI_OPERATOR_TRAITS_HPP
|
|
|
|
// end of file AnasaziOperatorTraits.hpp
|