Sacado_Fad_SimpleFad.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                           Sacado Package
//
// Copyright 2006 NTESS and the Sacado contributors.
// SPDX-License-Identifier: LGPL-2.1-or-later
// *****************************************************************************
// @HEADER

#ifndef SACADO_FAD_SIMPLEFAD_HPP
#define SACADO_FAD_SIMPLEFAD_HPP

#include "Sacado_Fad_SimpleFadTraits.hpp"
#include "Sacado_Fad_GeneralFad.hpp"
#include "Sacado_Fad_DynamicStorage.hpp"

namespace Sacado {

  namespace Fad {

    template <typename ValueT>
    class SimpleFad : public GeneralFad<ValueT,DynamicStorage<ValueT> > {

    public:

      typedef DynamicStorage<ValueT> StorageType;
      typedef GeneralFad<ValueT,StorageType> GeneralFadType;

      typedef typename GeneralFadType::value_type value_type;

      typedef typename GeneralFadType::scalar_type scalar_type;

      typedef typename ScalarType<ValueT>::type ScalarT;

      template <typename T>
      struct apply {
        typedef SimpleFad<T> type;
      };



      SimpleFad() :
        GeneralFadType() {}


      template <typename S>
      SimpleFad(const S& x, SACADO_ENABLE_VALUE_CTOR_DECL) :
        GeneralFadType(x) {}


      SimpleFad(const int sz, const ValueT& x, const DerivInit zero_out = InitDerivArray) :
        GeneralFadType(sz,x,zero_out) {}


      SimpleFad(const int sz, const int i, const ValueT & x) :
        GeneralFadType(sz,i,x) {}

      SimpleFad(const SimpleFad& x) :
        GeneralFadType(x) {}

      SimpleFad(const SimpleFad& x, const ValueT& v, const ValueT& partial) :
        GeneralFadType(x.size(), v) {
        for (int i=0; i<this->size(); i++)
          this->fastAccessDx(i) = x.fastAccessDx(i)*partial;
      }


      ~SimpleFad() {}

      bool isEqualTo(const SimpleFad& x) const {
        typedef IsEqual<value_type> IE;
        if (x.size() != this->size()) return false;
        bool eq = IE::eval(x.val(), this->val());
        for (int i=0; i<this->size(); i++)
          eq = eq && IE::eval(x.dx(i), this->dx(i));
        return eq;
      }

      template <typename S>
      SACADO_ENABLE_VALUE_FUNC(SimpleFad&) operator=(const S& v) {
        GeneralFadType::operator=(v);
        return *this;
      }

      SimpleFad& operator=(const SimpleFad& x) {
        GeneralFadType::operator=(static_cast<const GeneralFadType&>(x));
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(SimpleFad&) operator += (const S& x) {
        GeneralFadType::operator+=(x);
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(SimpleFad&) operator -= (const S& x) {
        GeneralFadType::operator-=(x);
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(SimpleFad&) operator *= (const S& x) {
        GeneralFadType::operator*=(x);
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(SimpleFad&) operator /= (const S& x) {
        GeneralFadType::operator/=(x);
        return *this;
      }

      SACADO_INLINE_FUNCTION
      SimpleFad& operator += (const SimpleFad& x) {
        GeneralFadType::operator+=(static_cast<const GeneralFadType&>(x));
        return *this;
      }

      SACADO_INLINE_FUNCTION
      SimpleFad& operator -= (const SimpleFad& x) {
        GeneralFadType::operator-=(static_cast<const GeneralFadType&>(x));
        return *this;
      }

      SACADO_INLINE_FUNCTION
      SimpleFad& operator *= (const SimpleFad& x) {
        GeneralFadType::operator*=(static_cast<const GeneralFadType&>(x));
        return *this;
      }

      SACADO_INLINE_FUNCTION
      SimpleFad& operator /= (const SimpleFad& x) {
        GeneralFadType::operator/=(static_cast<const GeneralFadType&>(x));
        return *this;
      }

    }; // class SimpleFad<ValueT>

  } // namespace Fad

} // namespace Sacado

// Include elementary operation overloads
#include "Sacado_Fad_SimpleFadOps.hpp"

#endif // SACADO_FAD_SIMPLEFAD_HPP