Anasazi  Version of the Day
AnasaziOperatorTraits.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Anasazi: Block Eigensolvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ANASAZI_OPERATOR_TRAITS_HPP
43 #define ANASAZI_OPERATOR_TRAITS_HPP
44 
49 #include "AnasaziConfigDefs.hpp"
50 #include "AnasaziTypes.hpp"
51 
52 
53 namespace Anasazi {
54 
55 
57  class OperatorError : public AnasaziError
58  {public: OperatorError(const std::string& what_arg) : AnasaziError(what_arg) {}};
59 
60 
64  template< class ScalarType, class MV, class OP >
66  {
68 
72  static inline void notDefined() { return OP::this_type_is_missing_a_specialization(); };
73  };
74 
75 
83  template <class ScalarType, class MV, class OP>
85  {
86  public:
87 
89 
90 
92  static void Apply ( const OP& Op,
93  const MV& x,
94  MV& y )
96 
98 
99  };
100 
101 } // end Anasazi namespace
102 
103 #endif // ANASAZI_OPERATOR_TRAITS_HPP
104 
105 // end of file AnasaziOperatorTraits.hpp
Anasazi::OperatorTraits::Apply
static void Apply(const OP &Op, const MV &x, MV &y)
Application method which performs operation y = Op*x. An OperatorError exception is thrown if there i...
Definition: AnasaziOperatorTraits.hpp:92
AnasaziTypes.hpp
Types and exceptions used within Anasazi solvers and interfaces.
Anasazi::OperatorError
Exceptions thrown to signal error in operator application.
Definition: AnasaziOperatorTraits.hpp:57
Anasazi::UndefinedOperatorTraits::notDefined
static void notDefined()
This function should not compile if there is an attempt to instantiate!
Definition: AnasaziOperatorTraits.hpp:72
Anasazi::OperatorTraits
Virtual base class which defines basic traits for the operator type.
Definition: AnasaziOperatorTraits.hpp:84
Anasazi::UndefinedOperatorTraits
This is the default struct used by OperatorTraits<ScalarType, MV, OP> class to produce a compile time...
Definition: AnasaziOperatorTraits.hpp:65
Anasazi
Namespace Anasazi contains the classes, structs, enums and utilities used by the Anasazi package.
Anasazi::AnasaziError
An exception class parent to all Anasazi exceptions.
Definition: AnasaziTypes.hpp:63
AnasaziConfigDefs.hpp
Anasazi header file which uses auto-configuration information to include necessary C++ headers.