Sacado Package Browser (Single Doxygen Collection) Version of the Day
Sacado_ELRCacheFad_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_ELRCACHEFAD_GENERALFAD_HPP
00055 #define SACADO_ELRCACHEFAD_GENERALFAD_HPP
00056 
00057 #include "Sacado_ELRCacheFad_Expression.hpp"
00058 #include "Sacado_dummy_arg.hpp"
00059 
00060 namespace Sacado {
00061 
00063   namespace ELRCacheFad {
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       void cache() const {}
00141 
00143 
00148 
00153       int availableSize() const { return this->length(); }
00154 
00156       bool hasFastAccess() const { return this->size()!=0;}
00157 
00159       bool isPassive() const { return this->size()==0;}
00160       
00162       void setIsConstant(bool is_const) { 
00163   if (is_const && this->size()!=0)
00164     this->resize(0);
00165       }
00166     
00168 
00173 
00175       GeneralFad& operator=(const T& val);
00176 
00178       GeneralFad& 
00179       operator=(const GeneralFad& x);
00180 
00182       template <typename S> 
00183       GeneralFad& operator=(const Expr<S>& x); 
00184 
00186 
00191 
00193       GeneralFad& operator += (const T& x);
00194 
00196       GeneralFad& operator -= (const T& x);
00197 
00199       GeneralFad& operator *= (const T& x);
00200 
00202       GeneralFad& operator /= (const T& x);
00203 
00205 
00209       GeneralFad& operator += (const typename dummy<value_type,scalar_type>::type& x);
00210 
00212 
00216       GeneralFad& operator -= (const typename dummy<value_type,scalar_type>::type& x);
00217 
00219 
00223       GeneralFad& operator *= (const typename dummy<value_type,scalar_type>::type& x);
00224 
00226 
00230       GeneralFad& operator /= (const typename dummy<value_type,scalar_type>::type& x);
00231 
00233       template <typename S> 
00234       GeneralFad& operator += (const Expr<S>& x);
00235 
00237       template <typename S> 
00238       GeneralFad& operator -= (const Expr<S>& x);
00239   
00241       template <typename S> 
00242       GeneralFad& operator *= (const Expr<S>& x);
00243 
00245       template <typename S> 
00246       GeneralFad& operator /= (const Expr<S>& x);
00247 
00249 
00250     protected:
00251 
00253       bool update_val_;
00254 
00255       // Functor for mpl::for_each to compute the local accumulation
00256       // of a tangent derivative
00257       template <typename ExprT>
00258       struct LocalAccumOp {
00259   typedef typename ExprT::value_type value_type;
00260   static const int N = ExprT::num_args;
00261   const ExprT& x;
00262   mutable value_type t;
00263   value_type partials[N];
00264   int i;
00265   inline LocalAccumOp(const ExprT& x_) :
00266     x(x_) { x.computePartials(value_type(1.), partials); }
00267   template <typename ArgT>
00268   inline void operator () (ArgT arg) const {
00269     const int Arg = ArgT::value;
00270     if (x.template isActive<Arg>())
00271       t += partials[Arg] * x.template getTangent<Arg>(i);
00272   }
00273       };
00274 
00275     }; // class GeneralFad
00276 
00277     
00278     template <typename T, typename Storage>
00279     std::ostream& operator << (std::ostream& os, 
00280                                const GeneralFad<T,Storage>& x) {
00281       os << x.val() << " [";
00282       
00283       for (int i=0; i< x.size(); i++) {
00284         os << " " << x.dx(i);
00285       }
00286 
00287       os << " ]";
00288       return os;
00289     }
00290 
00291   } // namespace ELRCacheFad
00292 
00293 } // namespace Sacado
00294 
00295 #include "Sacado_ELRCacheFad_GeneralFadImp.hpp"
00296 
00297 #endif // SACADO_ELRCACHEFAD_GENERALFAD_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines