Sacado Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Sacado_Fad_ViewFadTraits.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Sacado Package
5 // Copyright (2006) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // This library is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as
12 // published by the Free Software Foundation; either version 2.1 of the
13 // License, or (at your option) any later version.
14 //
15 // This library is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
23 // USA
24 // Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
25 // (etphipp@sandia.gov).
26 //
27 // ***********************************************************************
28 //
29 // The forward-mode AD classes in Sacado are a derivative work of the
30 // expression template classes in the Fad package by Nicolas Di Cesare.
31 // The following banner is included in the original Fad source code:
32 //
33 // ************ DO NOT REMOVE THIS BANNER ****************
34 //
35 // Nicolas Di Cesare <Nicolas.Dicesare@ann.jussieu.fr>
36 // http://www.ann.jussieu.fr/~dicesare
37 //
38 // CEMRACS 98 : C++ courses,
39 // templates : new C++ techniques
40 // for scientific computing
41 //
42 //********************************************************
43 //
44 // NumericalTraits class to illustrate TRAITS
45 //
46 //********************************************************
47 // @HEADER
48 
49 #ifndef SACADO_FAD_VIEWFADTRAITS_HPP
50 #define SACADO_FAD_VIEWFADTRAITS_HPP
51 
52 #include "Sacado_ConfigDefs.h"
53 
54 #ifdef SACADO_NEW_FAD_DESIGN_IS_DEFAULT
55 
57 
58 #else
59 
60 #include "Sacado_Traits.hpp"
61 
62 // Forward declarations
63 namespace Sacado {
64  namespace Fad {
65  template <typename T,unsigned,unsigned,typename> class ViewFad;
66  }
67 }
68 
69 namespace Sacado {
70 
73 
74 
75  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
76  struct ScalarType< Fad::ViewFad<ValueT,Size,Stride,Base> > {
78  };
79 
81  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
82  struct ValueType< Fad::ViewFad<ValueT,Size,Stride,Base> > {
83  typedef ValueT type;
84  };
85 
87  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
88  struct IsADType< Fad::ViewFad<ValueT,Size,Stride,Base> > {
89  static const bool value = true;
90  };
91 
93  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
94  struct IsScalarType< Fad::ViewFad<ValueT,Size,Stride,Base> > {
95  static const bool value = false;
96  };
97 
99  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
100  struct IsSimdType< Fad::ViewFad<ValueT,Size,Stride,Base> > {
101  static const bool value = IsSimdType<ValueT>::value;
102  };
103 
105  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
106  struct Value< Fad::ViewFad<ValueT,Size,Stride,Base> > {
110  return x.val(); }
111  };
112 
114  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
115  struct ScalarValue< Fad::ViewFad<ValueT,Size,Stride,Base> > {
120  return ScalarValue<value_type>::eval(x.val()); }
121  };
122 
124  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
125  struct StringName< Fad::ViewFad<ValueT,Size,Stride,Base> > {
126  static std::string eval() {
127  return std::string("Sacado::Fad::ViewFad< ") +
128  StringName<ValueT>::eval() + " >"; }
129  };
130 
132  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
133  struct IsEqual< Fad::ViewFad<ValueT,Size,Stride,Base> > {
137  return x.isEqualTo(y);
138  }
139  };
140 
142  template <typename ValueT, unsigned Size, unsigned Stride, typename Base>
143  struct IsStaticallySized< Fad::ViewFad<ValueT,Size,Stride,Base> > {
144  static const bool value = false;
145  };
146 
147 } // namespace Sacado
148 
149 // ViewFad is not a proper scalar type, so we don't define any of the
150 // Teuchos traits classes
151 
152 #endif // SACADO_NEW_FAD_DESIGN_IS_DEFAULT
153 
154 #endif // SACADO_FAD_DFADTRAITS_HPP
static std::string eval()
Base template specification for ScalarValue.
Base template specification for ScalarType.
Base template specification for string names of types.
static KOKKOS_INLINE_FUNCTION const value_type & eval(const Fad::ViewFad< ValueT, Size, Stride, Base > &x)
Base template specification for IsADType.
static KOKKOS_INLINE_FUNCTION const scalar_type & eval(const Fad::ViewFad< ValueT, Size, Stride, Base > &x)
Base template specification for Value.
ValueType< Fad::ViewFad< ValueT, Size, Stride, Base > >::type value_type
Base class for Sacado types to control overload resolution.
Definition: Sacado_Base.hpp:46
Base template specification for IsSimdType.
#define KOKKOS_INLINE_FUNCTION
static const bool value
Base template specification for testing equivalence.
static const bool value
ScalarType< Fad::ViewFad< ValueT, Size, Stride, Base > >::type scalar_type
static KOKKOS_INLINE_FUNCTION bool eval(const Fad::ViewFad< ValueT, Size, Stride, Base > &x, const Fad::ViewFad< ValueT, Size, Stride, Base > &y)
static const bool value
Fad::ViewFad< ValueT, Size, Stride, Base >::ScalarT type
ValueType< Fad::ViewFad< ValueT, Size, Stride, Base > >::type value_type
Base template specification for IsScalarType.
GeneralFad< ViewStorage< T, static_length, static_stride, U > > ViewFad
#define SACADO_VFAD_PROMOTE_SPEC(NS)
Base template specification for ValueType.
static KOKKOS_INLINE_FUNCTION const T & eval(const T &x)
Base template specification for testing whether type is statically sized.