Sacado Package Browser (Single Doxygen Collection) Version of the Day
Sacado_CacheFad_SFadImp.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 #include "Sacado_ConfigDefs.h"
00055 
00056 template <typename T, int Num> 
00057 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00058 Expr(const int sz, const T & x) : val_(x)
00059 {
00060 #ifdef SACADO_DEBUG
00061   if (sz != Num)
00062     throw "CacheFad::SFad() Error:  Supplied derivative dimension does not match compile time length.";
00063 #endif
00064 
00065   ss_array<T>::zero(dx_, Num); 
00066 }
00067 
00068 template <typename T, int Num> 
00069 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00070 Expr(const int sz, const int i, const T & x) : val_(x) 
00071 {
00072 #ifdef SACADO_DEBUG
00073   if (sz != Num)
00074     throw "CacheFad::SFad() Error:  Supplied derivative dimension does not match compile time length.";
00075   if (i >= Num)
00076     throw "CacheFad::SFad() Error:  Invalid derivative index.";
00077 #endif
00078 
00079   ss_array<T>::zero(dx_, Num);
00080   dx_[i]=1.; 
00081 }
00082 
00083 template <typename T, int Num> 
00084 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00085 Expr(const Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& x) : val_(x.val())
00086 { 
00087   for (int i=0; i<Num; i++)
00088     dx_[i] = x.dx_[i];
00089 }
00090 
00091 template <typename T, int Num> 
00092 template <typename S> 
00093 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00094 Expr(const Expr<S>& x) : val_(x.val())
00095 {
00096 #ifdef SACADO_DEBUG
00097   if (x.size() != Num)
00098     throw "CacheFad::SFad() Error:  Attempt to assign with incompatible sizes";
00099 #endif
00100 
00101   for(int i=0; i<Num; ++i) 
00102     dx_[i] = x.fastAccessDx(i);
00103 }
00104 
00105 
00106 template <typename T, int Num> 
00107 inline void 
00108 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00109 diff(const int ith, const int n) 
00110 { 
00111 #ifdef SACADO_DEBUG
00112   if (n != Num)
00113     throw "CacheFad::diff() Error:  Supplied derivative dimension does not match compile time length.";
00114 #endif
00115 
00116   ss_array<T>::zero(dx_, Num);
00117   dx_[ith] = T(1.);
00118 }
00119 
00120 template <typename T, int Num> 
00121 inline void 
00122 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00123 resize(int sz)
00124 {
00125 #ifdef SACADO_DEBUG
00126   if (sz != Num)
00127     throw "CacheFad::resize() Error:  Cannot resize fixed derivative array dimension";
00128 #endif
00129 }
00130 
00131 template <typename T, int Num> 
00132 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00133 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00134 operator=(const T& v) 
00135 {
00136   val_ = v;
00137   ss_array<T>::zero(dx_, Num);
00138 
00139   return *this;
00140 }
00141 
00142 template <typename T, int Num> 
00143 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00144 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00145 operator=(const Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& x) 
00146 {
00147   // Copy value
00148   val_ = x.val_;
00149 
00150   // Copy dx_
00151   for (int i=0; i<Num; i++)
00152     dx_[i] = x.dx_[i];
00153   
00154   return *this;
00155 }
00156 
00157 template <typename T, int Num> 
00158 template <typename S> 
00159 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00160 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00161 operator=(const Expr<S>& x) 
00162 {
00163 #ifdef SACADO_DEBUG
00164   if (x.size() != Num)
00165     throw "CacheFad::operator=() Error:  Attempt to assign with incompatible sizes";
00166 #endif
00167 
00168   // Compute value
00169   T xval = x.val();
00170 
00171   for(int i=0; i<Num; ++i)
00172     dx_[i] = x.fastAccessDx(i);
00173   
00174   val_ = xval;
00175   
00176   return *this;
00177 }
00178 
00179 template <typename T, int Num> 
00180 inline  Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00181 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00182 operator += (const T& v)
00183 {
00184   val_ += v;
00185 
00186   return *this;
00187 }
00188 
00189 template <typename T, int Num> 
00190 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00191 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00192 operator -= (const T& v)
00193 {
00194   val_ -= v;
00195 
00196   return *this;
00197 }
00198 
00199 template <typename T, int Num> 
00200 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00201 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00202 operator *= (const T& v)
00203 {
00204   val_ *= v;
00205 
00206   for (int i=0; i<Num; ++i)
00207     dx_[i] *= v;
00208 
00209   return *this;
00210 }
00211 
00212 template <typename T, int Num> 
00213 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00214 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00215 operator /= (const T& v)
00216 {
00217   val_ /= v;
00218 
00219   for (int i=0; i<Num; ++i)
00220     dx_[i] /= v;
00221 
00222   return *this;
00223 }
00224 
00225 template <typename T, int Num> 
00226 template <typename S> 
00227 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00228 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00229 operator += (const Sacado::CacheFad::Expr<S>& x)
00230 {
00231 #ifdef SACADO_DEBUG
00232   if (x.size() != Num)
00233     throw "CacheFad::operator+=() Error:  Attempt to assign with incompatible sizes";
00234 #endif
00235 
00236   // Compute value
00237   T xval = x.val();
00238 
00239   for (int i=0; i<Num; ++i)
00240     dx_[i] += x.fastAccessDx(i);
00241  
00242   val_ += xval;
00243 
00244   return *this;
00245 }
00246 
00247 template <typename T, int Num> 
00248 template <typename S> 
00249 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00250 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00251 operator -= (const Sacado::CacheFad::Expr<S>& x)
00252 {
00253 #ifdef SACADO_DEBUG
00254   if (x.size() != Num)
00255     throw "CacheFad::operator-=() Error:  Attempt to assign with incompatible sizes";
00256 #endif
00257 
00258   // Compute value
00259   T xval = x.val();
00260 
00261   for(int i=0; i<Num; ++i)
00262     dx_[i] -= x.fastAccessDx(i);
00263 
00264   val_ -= xval;
00265 
00266   return *this;
00267 }
00268 
00269 template <typename T, int Num> 
00270 template <typename S> 
00271 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00272 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00273 operator *= (const Sacado::CacheFad::Expr<S>& x)
00274 {
00275   T xval = x.val();
00276 
00277 #ifdef SACADO_DEBUG
00278   if (x.size() != Num)
00279     throw "CacheFad::operator*=() Error:  Attempt to assign with incompatible sizes";
00280 #endif
00281 
00282   for(int i=0; i<Num; ++i)
00283     dx_[i] = val_ * x.fastAccessDx(i) + dx_[i] * xval;
00284  
00285   val_ *= xval;
00286 
00287   return *this;
00288 }
00289 
00290 template <typename T, int Num>
00291 template <typename S> 
00292 inline Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >& 
00293 Sacado::CacheFad::Expr< Sacado::CacheFad::SFadExprTag<T,Num> >::
00294 operator /= (const Sacado::CacheFad::Expr<S>& x)
00295 {
00296   T xval = x.val();
00297 
00298 #ifdef SACADO_DEBUG
00299   if (x.size() != Num)
00300     throw "CacheFad::operator/=() Error:  Attempt to assign with incompatible sizes";
00301 #endif
00302 
00303   for(int i=0; i<Num; ++i)
00304     dx_[i] = ( dx_[i]*xval - val_*x.fastAccessDx(i) )/ (xval*xval);
00305 
00306   val_ /= xval;
00307 
00308   return *this;
00309 }
00310 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines