Sacado Package Browser (Single Doxygen Collection) Version of the Day
Sacado_ELRFad_GeneralFad.hpp
Go to the documentation of this file.
00001 // $Id$ 
00002 // $Source$ 
00003 // @HEADER
00004 // ***********************************************************************
00005 // 
00006 //                           Sacado Package
00007 //                 Copyright (2006) Sandia Corporation
00008 // 
00009 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00010 // the U.S. Government retains certain rights in this software.
00011 // 
00012 // This library is free software; you can redistribute it and/or modify
00013 // it under the terms of the GNU Lesser General Public License as
00014 // published by the Free Software Foundation; either version 2.1 of the
00015 // License, or (at your option) any later version.
00016 //  
00017 // This library is distributed in the hope that it will be useful, but
00018 // WITHOUT ANY WARRANTY; without even the implied warranty of
00019 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020 // Lesser General Public License for more details.
00021 //  
00022 // You should have received a copy of the GNU Lesser General Public
00023 // License along with this library; if not, write to the Free Software
00024 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00025 // USA
00026 // Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
00027 // (etphipp@sandia.gov).
00028 // 
00029 // ***********************************************************************
00030 //
00031 // The forward-mode AD classes in Sacado are a derivative work of the
00032 // expression template classes in the Fad package by Nicolas Di Cesare.  
00033 // The following banner is included in the original Fad source code:
00034 //
00035 // ************ DO NOT REMOVE THIS BANNER ****************
00036 //
00037 //  Nicolas Di Cesare <Nicolas.Dicesare@ann.jussieu.fr>
00038 //  http://www.ann.jussieu.fr/~dicesare
00039 //
00040 //            CEMRACS 98 : C++ courses, 
00041 //         templates : new C++ techniques 
00042 //            for scientific computing 
00043 // 
00044 //********************************************************
00045 //
00046 //  A short implementation ( not all operators and 
00047 //  functions are overloaded ) of 1st order Automatic
00048 //  Differentiation in forward mode (FAD) using
00049 //  EXPRESSION TEMPLATES.
00050 //
00051 //********************************************************
00052 // @HEADER
00053 
00054 #ifndef SACADO_ELRFAD_GENERALFAD_HPP
00055 #define SACADO_ELRFAD_GENERALFAD_HPP
00056 
00057 #include "Sacado_ELRFad_Expression.hpp"
00058 #include "Sacado_dummy_arg.hpp"
00059 
00060 namespace Sacado {
00061 
00063   namespace ELRFad {
00064 
00066 
00071     template <typename T, typename Storage> 
00072     class GeneralFad : public Storage {
00073 
00074     public:
00075 
00077       typedef T value_type;
00078 
00080       typedef typename ScalarType<T>::type scalar_type;
00081 
00086 
00088       GeneralFad() : Storage(T(0.)), update_val_(true) {}
00089 
00091 
00094       GeneralFad(const T & x) : Storage(x), update_val_(true) {}
00095 
00097 
00100       GeneralFad(const int sz, const T & x) : 
00101   Storage(sz, x), update_val_(true) {}
00102 
00104 
00109       GeneralFad(const int sz, const int i, const T & x) : 
00110   Storage(sz, x), update_val_(true) { 
00111   this->fastAccessDx(i)=1.; 
00112       }
00113 
00115       GeneralFad(const GeneralFad& x) : 
00116   Storage(x), update_val_(x.update_val_) {}
00117 
00119       template <typename S> GeneralFad(const Expr<S>& x);
00120 
00122       ~GeneralFad() {}
00123 
00125 
00131       void diff(const int ith, const int n);
00132 
00134       void setUpdateValue(bool update_val) { update_val_ = update_val; }
00135 
00137       bool updateValue() const { return update_val_; }
00138 
00140 
00145 
00150       int availableSize() const { return this->length(); }
00151 
00153       bool hasFastAccess() const { return this->size()!=0;}
00154 
00156       bool isPassive() const { return this->size()==0;}
00157       
00159       void setIsConstant(bool is_const) { 
00160   if (is_const && this->size()!=0)
00161     this->resize(0);
00162       }
00163     
00165 
00170 
00172       GeneralFad& operator=(const T& val);
00173 
00175       GeneralFad& 
00176       operator=(const GeneralFad& x);
00177 
00179       template <typename S> 
00180       GeneralFad& operator=(const Expr<S>& x); 
00181 
00183 
00188 
00190       GeneralFad& operator += (const T& x);
00191 
00193       GeneralFad& operator -= (const T& x);
00194 
00196       GeneralFad& operator *= (const T& x);
00197 
00199       GeneralFad& operator /= (const T& x);
00200 
00202 
00206       GeneralFad& operator += (const typename dummy<value_type,scalar_type>::type& x);
00207 
00209 
00213       GeneralFad& operator -= (const typename dummy<value_type,scalar_type>::type& x);
00214 
00216 
00220       GeneralFad& operator *= (const typename dummy<value_type,scalar_type>::type& x);
00221 
00223 
00227       GeneralFad& operator /= (const typename dummy<value_type,scalar_type>::type& x);
00228 
00230       template <typename S> 
00231       GeneralFad& operator += (const Expr<S>& x);
00232 
00234       template <typename S> 
00235       GeneralFad& operator -= (const Expr<S>& x);
00236   
00238       template <typename S> 
00239       GeneralFad& operator *= (const Expr<S>& x);
00240 
00242       template <typename S> 
00243       GeneralFad& operator /= (const Expr<S>& x);
00244 
00246 
00247     protected:
00248 
00250       bool update_val_;
00251 
00252       // Functor for mpl::for_each to compute the local accumulation
00253       // of a tangent derivative
00254       template <typename ExprT>
00255       struct LocalAccumOp {
00256   typedef typename ExprT::value_type value_type;
00257   static const int N = ExprT::num_args;
00258   const ExprT& x;
00259   mutable value_type t;
00260   value_type partials[N];
00261   int i;
00262   inline LocalAccumOp(const ExprT& x_) :
00263     x(x_) { x.computePartials(value_type(1.), partials); }
00264   template <typename ArgT>
00265   inline void operator () (ArgT arg) const {
00266     const int Arg = ArgT::value;
00267     if (x.template isActive<Arg>())
00268       t += partials[Arg] * x.template getTangent<Arg>(i);
00269   }
00270       };
00271 
00272     }; // class GeneralFad
00273 
00274     
00275     template <typename T, typename Storage>
00276     std::ostream& operator << (std::ostream& os, 
00277                                const GeneralFad<T,Storage>& x) {
00278       os << x.val() << " [";
00279       
00280       for (int i=0; i< x.size(); i++) {
00281         os << " " << x.dx(i);
00282       }
00283 
00284       os << " ]";
00285       return os;
00286     }
00287 
00288   } // namespace ELRFad
00289 
00290 } // namespace Sacado
00291 
00292 #include "Sacado_ELRFad_GeneralFadImp.hpp"
00293 
00294 #endif // SACADO_ELRFAD_GENERALFAD_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines