Sacado_Fad_Exp_StaticFixedStorage.hpp

Go to the documentation of this file.

// @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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact David M. Gay (dmgay@sandia.gov) or Eric T. Phipps
// (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER

#ifndef SACADO_FAD_EXP_STATICFIXEDSTORAGE_HPP
#define SACADO_FAD_EXP_STATICFIXEDSTORAGE_HPP

#include <type_traits>
#include <utility>

#include "Sacado_ConfigDefs.h"
#include "Sacado_StaticArrayTraits.hpp"

namespace Sacado {

  namespace Fad {
  namespace Exp {


    template <typename T, int Num>
    class StaticFixedStorage {

    public:

      typedef typename std::remove_cv<T>::type value_type;
      static constexpr bool is_statically_sized = true;
      static constexpr int static_size = Num;
      static constexpr bool is_view = false;

      template <typename TT>
      struct apply {
        typedef StaticFixedStorage<TT,Num> type;
      };

      template <int N>
      struct apply_N {
        typedef StaticFixedStorage<T,N> type;
      };

#ifdef SACADO_SFAD_INIT_DEFAULT_CONSTRUCTOR
      SACADO_INLINE_FUNCTION
      StaticFixedStorage() :
        val_(T(0.0)) {
        ss_array<T>::zero(dx_, Num);
      }
#else
      SACADO_DEFAULTED_FUNCTION
      StaticFixedStorage() = default;
#endif

      SACADO_INLINE_FUNCTION
      StaticFixedStorage(const T & x) :
        val_(x) {
        ss_array<T>::zero(dx_, Num);
      }


      SACADO_INLINE_FUNCTION
      StaticFixedStorage(const int sz, const T & x,
                         const DerivInit zero_out = InitDerivArray) :
        val_(x) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ ) && !defined(__HIP_DEVICE_COMPILE__)
        if (sz != Num)
          throw "StaticFixedStorage::StaticFixedStorage() Error:  Supplied derivative dimension does not equal static length.";
#endif
        if (zero_out == InitDerivArray)
          ss_array<T>::zero(dx_, Num);
      }


      SACADO_INLINE_FUNCTION
      StaticFixedStorage(const int sz, const int i, const value_type & x) :
        StaticFixedStorage(sz, x, InitDerivArray) {
        dx_[i]=1.;
      }


      SACADO_INLINE_FUNCTION
      StaticFixedStorage(const StaticFixedStorage& x) :
        val_(x.val_) {
         for (int i=0; i<Num; i++)
           dx_[i] = x.dx_[i];
      }

      SACADO_INLINE_FUNCTION
      StaticFixedStorage(StaticFixedStorage&& x) :
        val_(std::move(x.val_)) {
         for (int i=0; i<Num; i++)
           dx_[i] = std::move(x.dx_[i]);
      }

      SACADO_DEFAULTED_FUNCTION
      ~StaticFixedStorage() = default;


      SACADO_INLINE_FUNCTION
      StaticFixedStorage& operator=(const StaticFixedStorage& x) {
        if (this != &x) {
          val_ = x.val_;
          for (int i=0; i<Num; i++)
            dx_[i] = x.dx_[i];
        }
        return *this;
      }

      SACADO_INLINE_FUNCTION
      StaticFixedStorage& operator=(StaticFixedStorage&& x) {
        if (this != &x) {
          val_ = std::move(x.val_);
          for (int i=0; i<Num; i++)
            dx_[i] = std::move(x.dx_[i]);
        }
        return *this;
      }

      SACADO_INLINE_FUNCTION
      constexpr int size() const { return Num; }

      SACADO_INLINE_FUNCTION
      constexpr int length() const { return Num; }

      SACADO_INLINE_FUNCTION
      void resize(int sz) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ ) && !defined(__HIP_DEVICE_COMPILE__)
        if (sz != 0 && sz != Num)
          throw "StaticFixedStorage::resize() Error:  Cannot resize fixed storage length.";
#endif
        // Because we don't track a "used" length and can't set the length to 0,
        // we need to instead zero out derivative components if the length
        // requested is 0
        if (sz == 0)
          ss_array<T>::zero(dx_, Num);
      }

      SACADO_INLINE_FUNCTION
      void resizeAndZero(int sz) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ ) && !defined(__HIP_DEVICE_COMPILE__)
        if (sz != 0 && sz != Num)
          throw "StaticFixedStorage::resize() Error:  Cannot resize fixed storage length.";
#endif
        ss_array<T>::zero(dx_, Num);
      }

      SACADO_INLINE_FUNCTION
      void expand(int sz) {
#if defined(SACADO_DEBUG) && !defined(__CUDA_ARCH__ ) && !defined(__HIP_DEVICE_COMPILE__)
        if (sz != Num)
          throw "StaticFixedStorage::expand() Error:  Cannot resize fixed storage length.";
#endif
      }


      SACADO_INLINE_FUNCTION
      void zero() { ss_array<T>::zero(dx_, Num); }

      SACADO_INLINE_FUNCTION
      const T& val() const { return val_; }

      SACADO_INLINE_FUNCTION
      T& val() { return val_; }

      SACADO_INLINE_FUNCTION
      const T* dx() const { return dx_;}

      SACADO_INLINE_FUNCTION
      T dx(int i) const { return dx_[i]; }

      SACADO_INLINE_FUNCTION
      T& fastAccessDx(int i) { return dx_[i]; }

      SACADO_INLINE_FUNCTION
      const T& fastAccessDx(int i) const { return dx_[i]; }

    protected:

      T val_;

      T dx_[Num];

    }; // class StaticFixedStorage

  } // namespace Exp
  } // namespace Fad

} // namespace Sacado

#endif // SACADO_FAD_EXP_STATICFIXEDSTORAGE_HPP