Sacado_Fad_Exp_GeneralFad.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_EXP_GENERALFAD_HPP
#define SACADO_FAD_EXP_GENERALFAD_HPP

#include "Sacado_Fad_Exp_GeneralFadTraits.hpp"
#include "Sacado_Fad_Exp_Expression.hpp"
#include "Sacado_Fad_Exp_Extender.hpp"
#include "Sacado_Fad_Exp_ExprAssign.hpp"

namespace Sacado {

  namespace Fad {
  namespace Exp {


    template <typename Storage>
    class GeneralFad :
      public Expr< GeneralFad<Storage> >, // Brings in expression interface
      public Extender<Storage> // Brings in interface extensions & storage
    {
    public:

      typedef Storage StorageType;

      typedef Expr< GeneralFad<Storage> > ExprType;

      typedef Extender<Storage> ExtenderType;

      using typename StorageType::value_type;

      typedef typename ScalarType<value_type>::type scalar_type;

      static constexpr bool is_view = Storage::is_view;

      template <typename T>
      struct apply {
        typedef typename Storage::template apply<T>::type S;
        typedef GeneralFad<S> type;
      };

      template <int N>
      struct apply_N {
        typedef typename Storage::template apply_N<N>::type S;
        typedef GeneralFad<S> type;
      };


      using ExtenderType::ExtenderType;

      SACADO_DEFAULTED_FUNCTION
      GeneralFad() = default;

      SACADO_DEFAULTED_FUNCTION
      GeneralFad(const GeneralFad& x) = default;

      SACADO_DEFAULTED_FUNCTION
      GeneralFad(GeneralFad&& x) = default;

      template <typename S>
      SACADO_INLINE_FUNCTION
      GeneralFad(const S & x, SACADO_EXP_ENABLE_VALUE_CTOR_DECL) :
        ExtenderType(x) {}

      template <typename S>
      SACADO_INLINE_FUNCTION
      GeneralFad(const Expr<S>& x, SACADO_EXP_ENABLE_EXPR_CTOR_DECL) :
        ExtenderType(x.derived().size(), value_type(0.), NoInitDerivArray)
      {
        ExprAssign<GeneralFad>::assign_equal(*this, x.derived());
      }

      SACADO_DEFAULTED_FUNCTION
      ~GeneralFad() = default;


      SACADO_INLINE_FUNCTION
      void diff(const int ith, const int n) {
        if (this->size() != n)
          this->resize(n);

        this->zero();
        this->fastAccessDx(ith) = value_type(1.);
      }


      SACADO_INLINE_FUNCTION
      void setUpdateValue(bool update_val) {}


      SACADO_INLINE_FUNCTION
      bool updateValue() const { return true; }


      SACADO_INLINE_FUNCTION
      void cache() const {}

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_EXP_ENABLE_EXPR_FUNC(bool) isEqualTo(const Expr<S>& xx) const {
        typedef typename Expr<S>::derived_type expr_type;
        const expr_type& x = xx.derived();

        typedef IsEqual<value_type> IE;
        if (x.size() != this->size()) return false;
        bool eq = IE::eval(x.val(), this->val());
        const int sz = this->size();
        SACADO_FAD_DERIV_LOOP(i,sz)
          eq = eq && IE::eval(x.dx(i), this->dx(i));
        return eq;
      }



      SACADO_INLINE_FUNCTION
      int availableSize() const { return this->length(); }

      SACADO_INLINE_FUNCTION
      bool hasFastAccess() const { return this->size()!=0; }

      SACADO_INLINE_FUNCTION
      void setIsConstant(bool is_const) {
        if (is_const && this->size()!=0)
          this->resize(0);
      }



      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(GeneralFad&) operator=(const S& v) {
        this->val() = v;
        if (this->size()) this->resize(0);
        return *this;
      }

      SACADO_DEFAULTED_FUNCTION
      GeneralFad&
      operator=(const GeneralFad& x) = default;

      SACADO_DEFAULTED_FUNCTION
      GeneralFad&
      operator=(GeneralFad&& x) = default;

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_EXP_ENABLE_EXPR_FUNC(GeneralFad&) operator=(const Expr<S>& x) {
        ExprAssign<GeneralFad>::assign_equal(*this, x.derived());
        return *this;
      }



      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(GeneralFad&) operator += (const S& v) {
        this->val() += v;
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(GeneralFad&) operator -= (const S& v) {
        this->val() -= v;
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(GeneralFad&) operator *= (const S& v) {
        const int sz = this->size();
        this->val() *= v;
        SACADO_FAD_DERIV_LOOP(i,sz)
          this->fastAccessDx(i) *= v;
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_ENABLE_VALUE_FUNC(GeneralFad&) operator /= (const S& v) {
        const int sz = this->size();
        this->val() /= v;
        SACADO_FAD_DERIV_LOOP(i,sz)
          this->fastAccessDx(i) /= v;
        return *this;
      }

      SACADO_INLINE_FUNCTION
      GeneralFad& operator += (const GeneralFad& x) {
        ExprAssign<GeneralFad>::assign_plus_equal(*this, x);
        return *this;
      }

      SACADO_INLINE_FUNCTION
      GeneralFad& operator -= (const GeneralFad& x) {
        ExprAssign<GeneralFad>::assign_minus_equal(*this, x);
        return *this;
      }

      SACADO_INLINE_FUNCTION
      GeneralFad& operator *= (const GeneralFad& x) {
        ExprAssign<GeneralFad>::assign_times_equal(*this, x);
        return *this;
      }

      SACADO_INLINE_FUNCTION
      GeneralFad& operator /= (const GeneralFad& x) {
        ExprAssign<GeneralFad>::assign_divide_equal(*this, x);
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_EXP_ENABLE_EXPR_FUNC(GeneralFad&) operator += (const Expr<S>& x) {
        ExprAssign<GeneralFad>::assign_plus_equal(*this, x.derived());
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_EXP_ENABLE_EXPR_FUNC(GeneralFad&) operator -= (const Expr<S>& x) {
        ExprAssign<GeneralFad>::assign_minus_equal(*this, x.derived());
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_EXP_ENABLE_EXPR_FUNC(GeneralFad&) operator *= (const Expr<S>& x) {
        ExprAssign<GeneralFad>::assign_times_equal(*this, x.derived());
        return *this;
      }

      template <typename S>
      SACADO_INLINE_FUNCTION
      SACADO_EXP_ENABLE_EXPR_FUNC(GeneralFad&) operator /= (const Expr<S>& x) {
        ExprAssign<GeneralFad>::assign_divide_equal(*this, x.derived());
        return *this;
      }


    }; // class GeneralFad

    template <typename S>
    struct ExprLevel< GeneralFad<S> > {
      static constexpr unsigned value =
        ExprLevel< typename GeneralFad<S>::value_type >::value + 1;
    };

    template <typename S>
    struct IsFadExpr< GeneralFad<S> > {
      static constexpr bool value = true;
    };

  } // namespace Exp
  } // namespace Fad

  template <typename S>
  struct IsView< Fad::Exp::GeneralFad<S> > {
    static constexpr bool value =  Fad::Exp::GeneralFad<S>::is_view;
  };

  template <typename S>
  struct IsFad< Fad::Exp::GeneralFad<S> > {
    static constexpr bool value = true;
  };

  template <typename S>
  struct IsExpr< Fad::Exp::GeneralFad<S> > {
    static constexpr bool value = true;
  };

  template <typename S>
  struct BaseExprType< Fad::Exp::GeneralFad<S> > {
    typedef Fad::Exp::GeneralFad<S> type;
  };

} // namespace Sacado

#include "Sacado_Fad_Exp_Ops.hpp"

#endif // SACADO_FAD_EXP_GENERALFAD_HPP