Sacado_Fad_ScalarTraitsImp.hpp

Go to the documentation of this file.

// $Id$ 
// $Source$ 
// @HEADER
// ***********************************************************************
// 
//                           Sacado Package
//                 Copyright (2006) Sandia Corporation
// 
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
// 
// ***********************************************************************
// @HEADER

#ifndef SACADO_FAD_SCALARTRAITSIMP_HPP
#define SACADO_FAD_SCALARTRAITSIMP_HPP

#ifdef HAVE_SACADO_TEUCHOS

#include "Teuchos_ScalarTraits.hpp"
#include "Teuchos_SerializationTraits.hpp"
#include "Teuchos_SerializationTraitsHelpers.hpp"
#include "Teuchos_Assert.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"
#include "Sacado_mpl_apply.hpp"

#include <iterator>

namespace Sacado {

  namespace Fad {

    template <typename FadType>
    struct ScalarTraitsImp {
      typedef typename Sacado::ValueType<FadType>::type ValueT;

      typedef typename mpl::apply<FadType,typename Teuchos::ScalarTraits<ValueT>::magnitudeType>::type magnitudeType;
      typedef typename mpl::apply<FadType,typename Teuchos::ScalarTraits<ValueT>::halfPrecision>::type halfPrecision;
      typedef typename mpl::apply<FadType,typename Teuchos::ScalarTraits<ValueT>::doublePrecision>::type doublePrecision;

      static const bool isComplex = Teuchos::ScalarTraits<ValueT>::isComplex;
      static const bool isOrdinal = Teuchos::ScalarTraits<ValueT>::isOrdinal;
      static const bool isComparable = 
  Teuchos::ScalarTraits<ValueT>::isComparable;
      static const bool hasMachineParameters = 
  Teuchos::ScalarTraits<ValueT>::hasMachineParameters;
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType eps() {
  return Teuchos::ScalarTraits<ValueT>::eps();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType sfmin() {
  return Teuchos::ScalarTraits<ValueT>::sfmin();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType base()  {
  return Teuchos::ScalarTraits<ValueT>::base();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType prec()  {
  return Teuchos::ScalarTraits<ValueT>::prec();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType t()     {
  return Teuchos::ScalarTraits<ValueT>::t();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType rnd()   {
  return Teuchos::ScalarTraits<ValueT>::rnd();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType emin()  {
  return Teuchos::ScalarTraits<ValueT>::emin();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType rmin()  {
  return Teuchos::ScalarTraits<ValueT>::rmin();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType emax()  {
  return Teuchos::ScalarTraits<ValueT>::emax();
      }
      static typename Teuchos::ScalarTraits<ValueT>::magnitudeType rmax()  {
  return Teuchos::ScalarTraits<ValueT>::rmax();
      }
      static magnitudeType magnitude(const FadType& a) {
#ifdef TEUCHOS_DEBUG
  TEUCHOS_SCALAR_TRAITS_NAN_INF_ERR(
    a, "Error, the input value to magnitude(...) a = " << a << 
    " can not be NaN!" );
  TEUCHOS_TEST_FOR_EXCEPTION(is_fad_real(a) == false, std::runtime_error,
         "Complex magnitude is not a differentiable "
         "function of complex inputs.");
#endif
  //return std::fabs(a); 
  magnitudeType b(a.size(), 
      Teuchos::ScalarTraits<ValueT>::magnitude(a.val()));
  if (Teuchos::ScalarTraits<ValueT>::real(a.val()) >= 0)
    for (int i=0; i<a.size(); i++)
      b.fastAccessDx(i) = 
        Teuchos::ScalarTraits<ValueT>::magnitude(a.fastAccessDx(i));
  else
    for (int i=0; i<a.size(); i++)
      b.fastAccessDx(i) = 
        -Teuchos::ScalarTraits<ValueT>::magnitude(a.fastAccessDx(i));
  return b;
      }
      static ValueT zero()  { 
  return ValueT(0.0); 
      }
      static ValueT one()   { 
  return ValueT(1.0); 
      }
      
      // Conjugate is only defined for real derivative components
      static FadType conjugate(const FadType& x) {
#ifdef TEUCHOS_DEBUG
  TEUCHOS_TEST_FOR_EXCEPTION(is_fad_real(x) == false, std::runtime_error,
         "Complex conjugate is not a differentiable "
         "function of complex inputs.");
#endif
  FadType y = x;
  y.val() = Teuchos::ScalarTraits<ValueT>::conjugate(x.val());
  return y;
      }   

      // Real part is only defined for real derivative components
      static FadType real(const FadType& x) { 
#ifdef TEUCHOS_DEBUG
  TEUCHOS_TEST_FOR_EXCEPTION(is_fad_real(x) == false, std::runtime_error,
         "Real component is not a differentiable "
         "function of complex inputs.");
#endif
  FadType y = x;
  y.val() = Teuchos::ScalarTraits<ValueT>::real(x.val());
  return y;
      }

      // Imaginary part is only defined for real derivative components
      static FadType imag(const FadType& x) { 
#ifdef TEUCHOS_DEBUG
  TEUCHOS_TEST_FOR_EXCEPTION(is_fad_real(x) == false, std::runtime_error,
         "Imaginary component is not a differentiable "
         "function of complex inputs.");
#endif
  return FadType(Teuchos::ScalarTraits<ValueT>::imag(x.val()));
      }

      static ValueT nan() {
  return Teuchos::ScalarTraits<ValueT>::nan(); 
      }
      static bool isnaninf(const FadType& x) { 
  if (Teuchos::ScalarTraits<ValueT>::isnaninf(x.val()))
    return true;
  for (int i=0; i<x.size(); i++)
    if (Teuchos::ScalarTraits<ValueT>::isnaninf(x.dx(i)))
      return true;
  return false;
      }
      static void seedrandom(unsigned int s) { 
  Teuchos::ScalarTraits<ValueT>::seedrandom(s); 
      }
      static ValueT random() { 
  return Teuchos::ScalarTraits<ValueT>::random(); 
      }
      static std::string name() { 
  return Sacado::StringName<FadType>::eval(); 
      }
      static FadType squareroot(const FadType& x) {
#ifdef TEUCHOS_DEBUG
  TEUCHOS_SCALAR_TRAITS_NAN_INF_ERR(
    x, "Error, the input value to squareroot(...) a = " << x << 
    " can not be NaN!" );
#endif
  return std::sqrt(x); 
      }
      static FadType pow(const FadType& x, const FadType& y) { 
  return std::pow(x,y); 
      }

      // Helper function to determine whether a complex value is real
      static bool is_complex_real(const ValueT& x) {
  return 
    Teuchos::ScalarTraits<ValueT>::magnitude(x-Teuchos::ScalarTraits<ValueT>::real(x)) == 0;
      }

      // Helper function to determine whether a Fad type is real
      static bool is_fad_real(const FadType& x) {
  if (x.size() == 0)
    return true;
  if (Teuchos::ScalarTraits<ValueT>::isComplex) {
    if (!is_complex_real(x.val()))
      return false;
    for (int i=0; i<x.size(); i++)
      if (!is_complex_real(x.fastAccessDx(i)))
        return false;
  }
  return true;
      }

    }; // class ScalarTraitsImp

    template <typename Ordinal, typename FadType, typename Serializer>
    struct SerializationImp {

    private:

      typedef Teuchos::SerializationTraits<Ordinal,int> iSerT;

      typedef Teuchos::SerializationTraits<Ordinal,Ordinal> oSerT;

      typedef typename Sacado::ValueType<FadType>::type value_type;

    public:

      static const bool supportsDirectSerialization = false;



      static Ordinal fromCountToIndirectBytes(const Serializer& vs,
                const Ordinal count, 
                const FadType buffer[],
                const Ordinal sz = 0) { 
  Ordinal bytes = 0;
        FadType *x = NULL;
        const FadType *cx;
  for (Ordinal i=0; i<count; i++) {
    int my_sz = buffer[i].size();
    int tot_sz = sz;
    if (sz == 0) tot_sz = my_sz;
    Ordinal b1 = iSerT::fromCountToIndirectBytes(1, &tot_sz);
    Ordinal b2 = vs.fromCountToIndirectBytes(1, &(buffer[i].val()));
    Ordinal b3 = oSerT::fromCountToIndirectBytes(1, &b2);
          Ordinal b4;
    if (tot_sz != my_sz) {
            if (x == NULL)
              x = new FadType(tot_sz, 0.0);
      *x = buffer[i];
            x->expand(tot_sz);
            cx = x;
    }
          else 
            cx = &(buffer[i]);
    b4 = vs.fromCountToIndirectBytes(tot_sz, cx->dx());
    Ordinal b5 = oSerT::fromCountToIndirectBytes(1, &b4);
    bytes += b1+b2+b3+b4+b5;
  }
        if (x != NULL)
          delete x;
  return bytes;
      }

      static void serialize (const Serializer& vs,
           const Ordinal count, 
           const FadType buffer[], 
           const Ordinal bytes, 
           char charBuffer[],
           const Ordinal sz = 0) { 
        FadType *x = NULL;
        const FadType *cx;
  for (Ordinal i=0; i<count; i++) {
    // First serialize size
    int my_sz = buffer[i].size();
    int tot_sz = sz;
    if (sz == 0) tot_sz = my_sz;
    Ordinal b1 = iSerT::fromCountToIndirectBytes(1, &tot_sz);
    iSerT::serialize(1, &tot_sz, b1, charBuffer);
    charBuffer += b1;
  
    // Next serialize value
    Ordinal b2 = vs.fromCountToIndirectBytes(1, &(buffer[i].val()));
    Ordinal b3 = oSerT::fromCountToIndirectBytes(1, &b2);
    oSerT::serialize(1, &b2, b3, charBuffer); 
    charBuffer += b3;
    vs.serialize(1, &(buffer[i].val()), b2, charBuffer);
    charBuffer += b2;
  
    // Next serialize derivative array
          Ordinal b4;
          if (tot_sz != my_sz) {
            if (x == NULL)
              x = new FadType(tot_sz, 0.0);
      *x = buffer[i];
            x->expand(tot_sz);
            cx = x;
    }
          else 
            cx = &(buffer[i]);
    b4 = vs.fromCountToIndirectBytes(tot_sz, cx->dx());
    Ordinal b5 = oSerT::fromCountToIndirectBytes(1, &b4);
    oSerT::serialize(1, &b4, b5, charBuffer); 
    charBuffer += b5;
    vs.serialize(tot_sz, cx->dx(), b4, charBuffer);
    charBuffer += b4;
  }
        if (x != NULL)
          delete x;
      }

      static Ordinal fromIndirectBytesToCount(const Serializer& vs,
                const Ordinal bytes, 
                const char charBuffer[],
                const Ordinal sz = 0) {
  Ordinal count = 0;
  Ordinal bytes_used = 0;
  while (bytes_used < bytes) {
  
    // Bytes for size
    Ordinal b1 = iSerT::fromCountToDirectBytes(1);
    bytes_used += b1;
    charBuffer += b1;
  
    // Bytes for value
    Ordinal b3 = oSerT::fromCountToDirectBytes(1);
    const Ordinal *b2 = oSerT::convertFromCharPtr(charBuffer);
    bytes_used += b3;
    charBuffer += b3;
    bytes_used += *b2;
    charBuffer += *b2;
  
    // Bytes for derivative array
    Ordinal b5 = oSerT::fromCountToDirectBytes(1);
    const Ordinal *b4 = oSerT::convertFromCharPtr(charBuffer);
    bytes_used += b5;
    charBuffer += b5;
    bytes_used += *b4;
    charBuffer += *b4;
  
    ++count;
  }
  return count;
      }

      static void deserialize (const Serializer& vs,
             const Ordinal bytes, 
             const char charBuffer[], 
             const Ordinal count, 
             FadType buffer[],
             const Ordinal sz = 0) { 
  for (Ordinal i=0; i<count; i++) {
  
    // Deserialize size
    Ordinal b1 = iSerT::fromCountToDirectBytes(1);
    const int *my_sz = iSerT::convertFromCharPtr(charBuffer);
    charBuffer += b1;
  
    // Create empty Fad object of given size
    int tot_sz = sz;
    if (sz == 0) tot_sz = *my_sz;
    buffer[i] = FadType(tot_sz, 0.0);
  
    // Deserialize value
    Ordinal b3 = oSerT::fromCountToDirectBytes(1);
    const Ordinal *b2 = oSerT::convertFromCharPtr(charBuffer);
    charBuffer += b3;
    vs.deserialize(*b2, charBuffer, 1, &(buffer[i].val()));
    charBuffer += *b2;
  
    // Deserialize derivative array
    Ordinal b5 = oSerT::fromCountToDirectBytes(1);
    const Ordinal *b4 = oSerT::convertFromCharPtr(charBuffer);
    charBuffer += b5;
    vs.deserialize(*b4, charBuffer, *my_sz, 
           &(buffer[i].fastAccessDx(0)));
    charBuffer += *b4;
  }
      
      }
  
      
    };

    template <typename Ordinal, typename FadType>
    struct SerializationTraitsImp {

    private:

      typedef typename Sacado::ValueType<FadType>::type ValueT;

      typedef Teuchos::DefaultSerializer<Ordinal,ValueT> DS;

      typedef typename DS::DefaultSerializerType ValueSerializer;

      typedef SerializationImp<Ordinal,FadType,ValueSerializer> Imp;

    public:

      static const bool supportsDirectSerialization = 
  Imp::supportsDirectSerialization;



      static Ordinal fromCountToIndirectBytes(const Ordinal count, 
                const FadType buffer[]) { 
  return Imp::fromCountToIndirectBytes(
    DS::getDefaultSerializer(), count, buffer);
      }

      static void serialize (const Ordinal count, 
           const FadType buffer[], 
           const Ordinal bytes, 
           char charBuffer[]) { 
  Imp::serialize(
    DS::getDefaultSerializer(), count, buffer, bytes, charBuffer);
      }

      static Ordinal fromIndirectBytesToCount(const Ordinal bytes, 
                const char charBuffer[]) {
  return Imp::fromIndirectBytesToCount(
    DS::getDefaultSerializer(), bytes, charBuffer);
      }

      static void deserialize (const Ordinal bytes, 
             const char charBuffer[], 
             const Ordinal count, 
             FadType buffer[]) { 
  Imp::deserialize(
    DS::getDefaultSerializer(), bytes, charBuffer, count, buffer);
      }
  
      
    };

    template <typename Ordinal, typename FadType>
    struct StaticSerializationTraitsImp {
      typedef typename Sacado::ValueType<FadType>::type ValueT;
      typedef Teuchos::SerializationTraits<Ordinal,ValueT> vSerT;
      typedef Teuchos::DirectSerializationTraits<Ordinal,FadType> DSerT;
      typedef Sacado::Fad::SerializationTraitsImp<Ordinal,FadType> STI;

      static const bool supportsDirectSerialization = 
  vSerT::supportsDirectSerialization;



      static Ordinal fromCountToDirectBytes(const Ordinal count) { 
  return DSerT::fromCountToDirectBytes(count);
      }

      static char* convertToCharPtr( FadType* ptr ) { 
  return DSerT::convertToCharPtr(ptr);
      }
      
      static const char* convertToCharPtr( const FadType* ptr ) { 
  return DSerT::convertToCharPtr(ptr);
      }
      
      static Ordinal fromDirectBytesToCount(const Ordinal bytes) { 
  return DSerT::fromDirectBytesToCount(bytes);
      }
      
      static FadType* convertFromCharPtr( char* ptr ) { 
  return DSerT::convertFromCharPtr(ptr);
      }
      
      static const FadType* convertFromCharPtr( const char* ptr ) { 
  return DSerT::convertFromCharPtr(ptr);
      }




      static Ordinal fromCountToIndirectBytes(const Ordinal count, 
                const FadType buffer[]) { 
  if (supportsDirectSerialization)
    return DSerT::fromCountToIndirectBytes(count, buffer);
  else
    return STI::fromCountToIndirectBytes(count, buffer);
      }

      static void serialize (const Ordinal count, 
           const FadType buffer[], 
           const Ordinal bytes, 
           char charBuffer[]) { 
  if (supportsDirectSerialization)
    return DSerT::serialize(count, buffer, bytes, charBuffer);
  else
    return STI::serialize(count, buffer, bytes, charBuffer);
      }

      static Ordinal fromIndirectBytesToCount(const Ordinal bytes, 
                const char charBuffer[]) {
  if (supportsDirectSerialization)
    return DSerT::fromIndirectBytesToCount(bytes, charBuffer);
  else
    return STI::fromIndirectBytesToCount(bytes, charBuffer);
      }

      static void deserialize (const Ordinal bytes, 
             const char charBuffer[], 
             const Ordinal count, 
             FadType buffer[]) { 
  if (supportsDirectSerialization)
    return DSerT::deserialize(bytes, charBuffer, count, buffer);
  else
    return STI::deserialize(bytes, charBuffer, count, buffer);
      }

      
    };

    template <typename Ordinal, typename FadType, typename ValueSerializer>
    class SerializerImp {

    private:

      typedef SerializationImp<Ordinal,FadType,ValueSerializer> Imp;

      Teuchos::RCP<const ValueSerializer> vs;

      Ordinal sz;

    public:

      typedef ValueSerializer value_serializer_type;

      static const bool supportsDirectSerialization = 
  Imp::supportsDirectSerialization;

      SerializerImp(const Teuchos::RCP<const ValueSerializer>& vs_,
        Ordinal sz_ = 0) :
  vs(vs_), sz(sz_) {}

      Ordinal getSerializerSize() const { return sz; }
      
      Teuchos::RCP<const value_serializer_type> getValueSerializer() const { 
  return vs; }



      Ordinal fromCountToIndirectBytes(const Ordinal count, 
               const FadType buffer[]) const { 
  return Imp::fromCountToIndirectBytes(*vs, count, buffer, sz);
      }

      void serialize (const Ordinal count, 
          const FadType buffer[], 
          const Ordinal bytes, 
          char charBuffer[]) const { 
  Imp::serialize(*vs, count, buffer, bytes, charBuffer, sz);
      }

      Ordinal fromIndirectBytesToCount(const Ordinal bytes, 
               const char charBuffer[]) const {
  return Imp::fromIndirectBytesToCount(*vs, bytes, charBuffer, sz);
      }

      void deserialize (const Ordinal bytes, 
      const char charBuffer[], 
      const Ordinal count, 
      FadType buffer[]) const { 
  return Imp::deserialize(*vs, bytes, charBuffer, count, buffer, sz);
      }
  
      
    };

  } // namespace Fad

} // namespace Sacado

#endif // HAVE_SACADO_TEUCHOS

#endif // SACADO_FAD_SCALARTRAITSIMP_HPP