Stokhos_DynamicStridedStorage.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                           Stokhos Package
//                 Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER

#ifndef STOKHOS_DYNAMIC_STRIDED_STORAGE_HPP
#define STOKHOS_DYNAMIC_STRIDED_STORAGE_HPP

#include "Stokhos_DynArrayTraits.hpp"

#include "Kokkos_Macros.hpp"

#include "Sacado_Traits.hpp"
#include "Stokhos_KokkosTraits.hpp"
#include <sstream>

namespace Stokhos {

  template <typename ordinal_t, typename value_t, typename device_t>
  class DynamicStridedStorage {
  public:

    static const bool is_static = false;
    static const int static_size = 0;
    static const bool supports_reset = true;

    typedef ordinal_t ordinal_type;
    typedef value_t value_type;
    typedef device_t execution_space;
    typedef value_type& reference;
    typedef volatile value_type& volatile_reference;
    typedef const value_type& const_reference;
    typedef const volatile value_type& const_volatile_reference;
    typedef value_type* pointer;
    typedef volatile value_type* volatile_pointer;
    typedef const value_type* const_pointer;
    typedef const volatile value_type* const_volatile_pointer;
    typedef Stokhos::DynArrayTraits<value_type,execution_space> ds;

    template <typename ord_t, typename val_t = value_t, typename dev_t = device_t >
    struct apply {
      typedef DynamicStridedStorage<ord_t,val_t,dev_t> type;
    };

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage(const ordinal_type& sz = 1,
                          const value_type& x = value_type(0.0)) :
      sz_(sz), stride_(1), is_owned_(true) {
      coeff_ = ds::get_and_fill(sz_, x);
    }

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage(const ordinal_type& sz, const value_type* x) :
      sz_(sz), stride_(1), is_owned_(true) {
      coeff_ = ds::get_and_fill(x, sz_);
    }

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage(const ordinal_type& sz, pointer v, bool owned) :
      coeff_(v), sz_(sz), stride_(1), is_owned_(owned) {}

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage(const DynamicStridedStorage& s) :
    sz_(s.sz_), stride_(1), is_owned_(true) {
      if (s.stride_ == 1)
        coeff_ = ds::get_and_fill(s.coeff_, sz_);
      else {
        coeff_ = ds::get_and_fill(sz_);
        for (ordinal_type i=0; i<sz_; ++i)
          coeff_[i] = s[i];
      }
    }

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage(const volatile DynamicStridedStorage& s) :
    sz_(s.sz_), stride_(1), is_owned_(true) {
      if (s.stride_ == 1)
        coeff_ = ds::get_and_fill(s.coeff_, sz_);
      else {
        coeff_ = ds::get_and_fill(sz_);
        for (ordinal_type i=0; i<sz_; ++i)
          coeff_[i] = s[i];
      }
    }

    KOKKOS_INLINE_FUNCTION
    ~DynamicStridedStorage() {
      if (is_owned_) ds::destroy_and_release(coeff_, sz_*stride_);
    }

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage& operator=(const DynamicStridedStorage& s) {
      if (&s != this) {
        if (s.sz_ != sz_) {
          if (is_owned_)
            ds::destroy_and_release(coeff_, sz_*stride_);
          if (s.stride_ == 1)
            coeff_ = ds::get_and_fill(s.coeff_, s.sz_);
          else {
            coeff_ = ds::get_and_fill(s.sz_);
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i] = s[i];
          }
          sz_ = s.sz_;
          stride_ = 1;
          is_owned_ = true;
        }
        else {
          if (stride_ == 1 and s.stride_ == 1)
            ds::copy(s.coeff_, coeff_, sz_);
          else
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i*stride_] = s[i];
        }
      }
      return *this;
    }

    KOKKOS_INLINE_FUNCTION
    DynamicStridedStorage& operator=(const volatile DynamicStridedStorage& s) {
      if (&s != this) {
        if (s.sz_ != sz_) {
          if (is_owned_)
            ds::destroy_and_release(coeff_, sz_*stride_);
          if (s.stride_ == 1)
            coeff_ = ds::get_and_fill(s.coeff_, s.sz_);
          else {
            coeff_ = ds::get_and_fill(s.sz_);
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i] = s[i];
          }
          sz_ = s.sz_;
          stride_ = 1;
          is_owned_ = true;
        }
        else {
          if (stride_ == 1 and s.stride_ == 1)
            ds::copy(s.coeff_, coeff_, sz_);
          else
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i*stride_] = s[i];
        }
      }
      return *this;
    }

    KOKKOS_INLINE_FUNCTION
    volatile DynamicStridedStorage&
    operator=(const DynamicStridedStorage& s) volatile {
      if (&s != this) {
        if (s.sz_ != sz_) {
          if (is_owned_)
            ds::destroy_and_release(coeff_, sz_*stride_);
          if (s.stride_ == 1)
            coeff_ = ds::get_and_fill(s.coeff_, s.sz_);
          else {
            coeff_ = ds::get_and_fill(s.sz_);
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i] = s[i];
          }
          sz_ = s.sz_;
          stride_ = 1;
          is_owned_ = true;
        }
        else {
          if (stride_ == 1 and s.stride_ == 1)
            ds::copy(s.coeff_, coeff_, sz_);
          else
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i*stride_] = s[i];
        }
      }
      return *this;
    }

    KOKKOS_INLINE_FUNCTION
    volatile DynamicStridedStorage&
    operator=(const volatile DynamicStridedStorage& s) volatile {
      if (&s != this) {
        if (s.sz_ != sz_) {
          if (is_owned_)
            ds::destroy_and_release(coeff_, sz_*stride_);
          if (s.stride_ == 1)
            coeff_ = ds::get_and_fill(s.coeff_, s.sz_);
          else {
            coeff_ = ds::get_and_fill(s.sz_);
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i] = s[i];
          }
          sz_ = s.sz_;
          stride_ = 1;
          is_owned_ = true;
        }
        else {
          if (stride_ == 1 and s.stride_ == 1)
            ds::copy(s.coeff_, coeff_, sz_);
          else
            for (ordinal_type i=0; i<s.sz_; ++i)
              coeff_[i*stride_] = s[i];
        }
      }
      return *this;
    }

    KOKKOS_INLINE_FUNCTION
    void init(const_reference v) {
      if (stride_ == 1)
        ds::fill(coeff_, sz_, v);
      else
        for (ordinal_type i=0; i<sz_; ++i)
          coeff_[i*stride_] = v;
    }

    KOKKOS_INLINE_FUNCTION
    void init(const_reference v) volatile {
      if (stride_ == 1)
        ds::fill(coeff_, sz_, v);
      else
        for (ordinal_type i=0; i<sz_; ++i)
          coeff_[i*stride_] = v;
    }

    KOKKOS_INLINE_FUNCTION
    void init(const_pointer v, const ordinal_type& sz = 0) {
      ordinal_type my_sz = sz;
      if (sz == 0)
        my_sz = sz_;
      if (stride_ == 1)
        ds::copy(v, coeff_, my_sz);
      else
        for (ordinal_type i=0; i<my_sz; ++i)
          coeff_[i*stride_] = v[i];
    }

    KOKKOS_INLINE_FUNCTION
    void init(const_pointer v, const ordinal_type& sz = 0) volatile {
      ordinal_type my_sz = sz;
      if (sz == 0)
        my_sz = sz_;
      if (stride_ == 1)
        ds::copy(v, coeff_, my_sz);
      else
        for (ordinal_type i=0; i<my_sz; ++i)
          coeff_[i*stride_] = v[i];
    }

    KOKKOS_INLINE_FUNCTION
    void load(pointer v) {
      if (stride_ == 1)
        copy(v, coeff_, sz_);
      for (ordinal_type i=0; i<sz_; ++i)
        coeff_[i*stride_] = v[i];
    }

    KOKKOS_INLINE_FUNCTION
    void load(pointer v) volatile {
      if (stride_ == 1)
        copy(v, coeff_, sz_);
      for (ordinal_type i=0; i<sz_; ++i)
        coeff_[i*stride_] = v[i];
    }

    KOKKOS_INLINE_FUNCTION
    void resize(const ordinal_type& sz) {
      if (sz != sz_) {
        value_type *coeff_new = ds::get_and_fill(sz);
        ordinal_type my_sz = sz_;
        if (sz_ > sz)
          my_sz = sz;
        if (stride_ == 1)
          ds::copy(coeff_, coeff_new, my_sz);
        else
          for (ordinal_type i=0; i<my_sz; ++i)
            coeff_new[i] = coeff_[i*stride_];
        if (is_owned_)
          ds::destroy_and_release(coeff_, sz_*stride_);
        coeff_ = coeff_new;
        sz_ = sz;
        stride_ = 1;
        is_owned_ = true;
      }
    }

    KOKKOS_INLINE_FUNCTION
    void resize(const ordinal_type& sz) volatile {
      if (sz != sz_) {
        value_type *coeff_new = ds::get_and_fill(sz);
        ordinal_type my_sz = sz_;
        if (sz_ > sz)
          my_sz = sz;
        if (stride_ == 1)
          ds::copy(coeff_, coeff_new, my_sz);
        else
          for (ordinal_type i=0; i<my_sz; ++i)
            coeff_new[i] = coeff_[i*stride_];
        if (is_owned_)
          ds::destroy_and_release(coeff_, sz_*stride_);
        coeff_ = coeff_new;
        sz_ = sz;
        stride_ = 1;
        is_owned_ = true;
      }
    }

    KOKKOS_INLINE_FUNCTION
    void shallowReset(pointer v, const ordinal_type& sz,
                      const ordinal_type& stride, bool owned) {
      if (is_owned_)
        ds::destroy_and_release(coeff_, sz_*stride_);
      coeff_ = v;
      sz_ = sz;
      stride_ = stride;
      is_owned_ = owned;
    }

    KOKKOS_INLINE_FUNCTION
    void shallowReset(pointer v, const ordinal_type& sz,
                      const ordinal_type& stride, bool owned) volatile {
      if (is_owned_)
        ds::destroy_and_release(coeff_, sz_*stride_);
      coeff_ = v;
      sz_ = sz;
      stride_ = stride;
      is_owned_ = owned;
    }

    KOKKOS_INLINE_FUNCTION
    ordinal_type size() const { return sz_; }

    KOKKOS_INLINE_FUNCTION
    ordinal_type size() const volatile { return sz_; }

    KOKKOS_INLINE_FUNCTION
    const_reference operator[] (const ordinal_type& i) const {
      return coeff_[i*stride_];
    }

    KOKKOS_INLINE_FUNCTION
    const_volatile_reference operator[] (const ordinal_type& i) const volatile {
      return coeff_[i*stride_];
    }

    KOKKOS_INLINE_FUNCTION
    reference operator[] (const ordinal_type& i) {
      return coeff_[i*stride_];
    }

    KOKKOS_INLINE_FUNCTION
    volatile_reference operator[] (const ordinal_type& i) volatile {
      return coeff_[i*stride_];
    }

    template <int i>
    KOKKOS_INLINE_FUNCTION
    reference getCoeff() { return coeff_[i*stride_]; }

    template <int i>
    KOKKOS_INLINE_FUNCTION
    volatile_reference getCoeff() volatile { return coeff_[i*stride_]; }

    template <int i>
    KOKKOS_INLINE_FUNCTION
    const_reference getCoeff() const { return coeff_[i*stride_]; }

    template <int i>
    KOKKOS_INLINE_FUNCTION
    const_volatile_reference getCoeff() const volatile { return coeff_[i*stride_]; }

    KOKKOS_INLINE_FUNCTION
    const_volatile_pointer coeff() const volatile { return coeff_; }

    KOKKOS_INLINE_FUNCTION
    const_pointer coeff() const { return coeff_; }

    KOKKOS_INLINE_FUNCTION
    volatile_pointer coeff() volatile { return coeff_; }

    KOKKOS_INLINE_FUNCTION
    pointer coeff() { return coeff_; }

  private:

    pointer coeff_;

    ordinal_type sz_;

    ordinal_type stride_;

    bool is_owned_;

  };

}

namespace Sacado {
  template <typename ordinal_t, typename value_t, typename device_t>
  struct StringName< Stokhos::DynamicStridedStorage<ordinal_t,
                                                    value_t,
                                                    device_t> > {
    static std::string eval() {
      std::stringstream ss;
      ss << "Stokhos::DynamicStridedStorage<"
         << StringName<ordinal_t>::eval() << ","
         << StringName<value_t>::eval() << ","
         << StringName<device_t>::eval() << ">";
      return ss.str();
    }
  };
}

#endif // STOKHOS_DYNAMIC_STORAGE_HPP