Sacado_Fad_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_FAD_GENERALFAD_HPP
00055 #define SACADO_FAD_GENERALFAD_HPP
00056 
00057 #include "Sacado_Fad_Expression.hpp"
00058 #include "Sacado_dummy_arg.hpp"
00059 
00060 namespace Sacado {
00061 
00063   namespace Fad {
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.)) {}
00089 
00091 
00094       GeneralFad(const T & x) : Storage(x) {}
00095 
00097 
00100       GeneralFad(const int sz, const T & x) : Storage(sz, x) {}
00101 
00103 
00108       GeneralFad(const int sz, const int i, const T & x) : 
00109   Storage(sz, x) { 
00110   this->fastAccessDx(i)=1.; 
00111       }
00112 
00114       GeneralFad(const GeneralFad& x) : 
00115   Storage(x) {}
00116 
00118       template <typename S> GeneralFad(const Expr<S>& x);
00119 
00121       ~GeneralFad() {}
00122 
00124 
00130       void diff(const int ith, const int n);
00131 
00133 
00138 
00143       int availableSize() const { return this->length(); }
00144 
00146       bool hasFastAccess() const { return this->size()!=0; }
00147 
00149       bool isPassive() const { return this->size()!=0; }
00150       
00152       void setIsConstant(bool is_const) { 
00153   if (is_const && this->size()!=0)
00154     this->resize(0);
00155       }
00156     
00158 
00163 
00165       GeneralFad& operator=(const T& val);
00166 
00168       GeneralFad& 
00169       operator=(const GeneralFad& x);
00170 
00172       template <typename S> 
00173       GeneralFad& operator=(const Expr<S>& x); 
00174 
00176 
00181 
00183       GeneralFad& operator += (const T& x);
00184 
00186       GeneralFad& operator -= (const T& x);
00187 
00189       GeneralFad& operator *= (const T& x);
00190 
00192       GeneralFad& operator /= (const T& x);
00193 
00195 
00199       GeneralFad& operator += (const typename dummy<value_type,scalar_type>::type& 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       template <typename S> 
00224       GeneralFad& operator += (const Expr<S>& x);
00225 
00227       template <typename S> 
00228       GeneralFad& operator -= (const Expr<S>& x);
00229   
00231       template <typename S> 
00232       GeneralFad& operator *= (const Expr<S>& x);
00233 
00235       template <typename S> 
00236       GeneralFad& operator /= (const Expr<S>& x);
00237 
00239 
00240     }; // class GeneralFad
00241 
00242   } // namespace Fad
00243 
00244 } // namespace Sacado
00245 
00246 #include "Sacado_Fad_GeneralFadImp.hpp"
00247 
00248 #endif // SACADO_FAD_GENERALFAD_HPP

Generated on Wed May 12 21:39:34 2010 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.4.7