Sacado_CacheFad_DFadTraits.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 //  NumericalTraits class to illustrate TRAITS
00047 //
00048 //********************************************************
00049 // @HEADER
00050 
00051 #ifndef SACADO_CACHEFAD_DFADTRAITS_HPP
00052 #define SACADO_CACHEFAD_DFADTRAITS_HPP
00053 
00054 #include "Sacado_Traits.hpp"
00055 
00056 // Forward declarations
00057 namespace Sacado {
00058   namespace CacheFad {
00059     template <typename T> class DFad;
00060   }
00061 }
00062 
00063 namespace Sacado {
00064 
00066   template <typename ValueT>
00067   struct Promote< CacheFad::DFad<ValueT>, CacheFad::DFad<ValueT> > {
00068     typedef CacheFad::DFad<ValueT> type;
00069   };
00070 
00072   template <typename ValueT, typename R>
00073   struct Promote< CacheFad::DFad<ValueT>, R > {
00074     typedef typename ValueType< CacheFad::DFad<ValueT> >::type value_type_l;
00075     typedef typename ValueType<R>::type value_type_r;
00076     typedef typename Promote<value_type_l,value_type_r>::type value_type;
00077 
00078     typedef CacheFad::DFad<value_type> type;
00079   };
00080 
00082   template <typename L, typename ValueT>
00083   struct Promote< L, CacheFad::DFad<ValueT> > {
00084   public:
00085 
00086     typedef typename ValueType<L>::type value_type_l;
00087     typedef typename ValueType< CacheFad::DFad<ValueT> >::type value_type_r;
00088     typedef typename Promote<value_type_l,value_type_r>::type value_type;
00089 
00090     typedef CacheFad::DFad<value_type> type;
00091   };
00092 
00094   template <typename ValueT>
00095   struct ScalarType< CacheFad::DFad<ValueT> > {
00096     typedef typename CacheFad::DFad<ValueT>::ScalarT type;
00097   };
00098 
00100   template <typename ValueT>
00101   struct ValueType< CacheFad::DFad<ValueT> > {
00102     typedef ValueT type;
00103   };
00104 
00106   template <typename ValueT>
00107   struct IsADType< CacheFad::DFad<ValueT> > {
00108     static const bool value = true;
00109   };
00110 
00112   template <typename ValueT>
00113   struct IsScalarType< CacheFad::DFad<ValueT> > {
00114     static const bool value = false;
00115   };
00116 
00118   template <typename ValueT>
00119   struct Value< CacheFad::DFad<ValueT> > {
00120     typedef typename ValueType< CacheFad::DFad<ValueT> >::type value_type;
00121     static const value_type& eval(const CacheFad::DFad<ValueT>& x) { 
00122       return x.val(); }
00123   };
00124 
00126   template <typename ValueT>
00127   struct ScalarValue< CacheFad::DFad<ValueT> > {
00128     typedef typename ValueType< CacheFad::DFad<ValueT> >::type value_type;
00129     typedef typename ScalarType< CacheFad::DFad<ValueT> >::type scalar_type;
00130     static const scalar_type& eval(const CacheFad::DFad<ValueT>& x) { 
00131       return ScalarValue<value_type>::eval(x.val()); }
00132   };
00133 
00135   template <typename ValueT>
00136   struct StringName< CacheFad::DFad<ValueT> > {
00137     static std::string eval() { 
00138       return std::string("Sacado::CacheFad::DFad< ") + 
00139   StringName<ValueT>::eval() + " >"; }
00140   };
00141 
00142 } // namespace Sacado
00143 
00144 // Define Teuchos traits classes
00145 #ifdef HAVE_SACADO_TEUCHOS
00146 #include "Teuchos_PromotionTraits.hpp"
00147 #include "Teuchos_ScalarTraits.hpp"
00148 #include "Sacado_Fad_ScalarTraitsImp.hpp"
00149 
00150 namespace Teuchos {
00151 
00153   template <typename ValueT>
00154   struct PromotionTraits< Sacado::CacheFad::DFad<ValueT>, 
00155         Sacado::CacheFad::DFad<ValueT> > {
00156     typedef typename Sacado::Promote< Sacado::CacheFad::DFad<ValueT>,
00157               Sacado::CacheFad::DFad<ValueT> >::type
00158     promote;
00159   };
00160 
00162   template <typename ValueT, typename R>
00163   struct PromotionTraits< Sacado::CacheFad::DFad<ValueT>, R > {
00164     typedef typename Sacado::Promote< Sacado::CacheFad::DFad<ValueT>, R >::type 
00165     promote;
00166   };
00167 
00169   template <typename L, typename ValueT>
00170   struct PromotionTraits< L, Sacado::CacheFad::DFad<ValueT> > {
00171   public:
00172     typedef typename Sacado::Promote< L, Sacado::CacheFad::DFad<ValueT> >::type 
00173     promote;
00174   };
00175 
00177   template <typename ValueT>
00178   struct ScalarTraits< Sacado::CacheFad::DFad<ValueT> > :
00179     public Sacado::Fad::ScalarTraitsImp< Sacado::CacheFad::DFad<ValueT> >
00180   {};
00181 }
00182 #endif // HAVE_SACADO_TEUCHOS
00183 
00184 #endif // SACADO_FAD_DFADTRAITS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:19:30 2011 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.6.3