Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Sacado_Fad_Expression.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// A short implementation ( not all operators and
45// functions are overloaded ) of 1st order Automatic
46// Differentiation in forward mode (FAD) using
47// EXPRESSION TEMPLATES.
48//
49//********************************************************
50// @HEADER
51
52#ifndef SACADO_FAD_EXPRESSION_HPP
53#define SACADO_FAD_EXPRESSION_HPP
54
55#include "Sacado_Traits.hpp"
57
58namespace Sacado {
59
60 namespace Fad {
61
63
70 template <typename> struct BaseExpr {};
71
72 struct ExprSpecDefault {};
73 template <typename ExprT> struct ExprSpec {
75 };
76
78
82 template <typename ExprT, typename Spec>
83 class Expr {
84 public:
86 };
87
88 template <typename ExprT, typename Spec>
89 struct ExprSpec< Expr<ExprT,Spec> > {
90 typedef Spec type;
91 };
92
94
99 template <typename T>
100 struct ExprLevel {
101 static const unsigned value = 0;
102 };
103
104 template <typename T>
105 struct ExprLevel< Expr<T> > {
106 static const unsigned value =
108 };
109
111 template <typename T>
112 struct IsFadExpr {
113 static const bool value = false;
114 };
115
116 template <typename T>
117 struct IsFadExpr< Expr<T> > {
118 static const bool value = true;
119 };
120
122
125 template <typename ConstT>
126 class ConstExpr {
127
128 public:
129
131 typedef ConstT value_type;
132
135
137 typedef ConstT base_expr_type;
138
142
145 const ConstT& val() const { return constant_; }
146
149 const ConstT& val(int j) const { return constant_; }
150
151 protected:
152
154 const ConstT& constant_;
155
156 }; // class ConstExpr
157
158 } // namespace Fad
159
160 template <typename T>
161 struct IsExpr< Fad::Expr<T> > {
162 static const bool value = true;
163 };
164
165 template <typename T>
166 struct BaseExprType< Fad::Expr<T> > {
168 };
169
170 template <typename T>
171 struct ValueType< Fad::ConstExpr<T> > {
173 };
174
175} // namespace Sacado
176
178
179#endif // SACADO_FAD_EXPRESSION_HPP
#define SACADO_INLINE_FUNCTION
Fad specializations for Teuchos::BLAS wrappers.
Constant expression template.
SACADO_INLINE_FUNCTION const ConstT & val() const
Return value of operation.
ConstT base_expr_type
Typename of base-expressions.
ScalarType< value_type >::type scalar_type
Typename of scalar's (which may be different from ConstT)
const ConstT & constant_
The constant.
SACADO_INLINE_FUNCTION ConstExpr(const ConstT &constant)
Constructor.
SACADO_INLINE_FUNCTION const ConstT & val(int j) const
Return value of operation.
ConstT value_type
Typename of argument values.
Wrapper for a generic expression template.
Get the base Fad type from a view/expression.
Meta-function for determining concrete base expression.
Meta-function for determining nesting with an expression.
Determine whether a given type is an expression.
Is a type an expression.
static const bool value
Base template specification for ValueType.