Tpetra_Details_createMirrorView.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef TPETRA_DETAILS_CREATEMIRRORVIEW_HPP
#define TPETRA_DETAILS_CREATEMIRRORVIEW_HPP

#include "TpetraCore_config.h"
#include "Teuchos_Array.hpp"
#include "Teuchos_ArrayView.hpp"
#include "Tpetra_Details_OrdinalTraits.hpp"
#include "Tpetra_Details_computeOffsets.hpp"
#include "Kokkos_Core.hpp"
#include <memory>
#include <string>


namespace Tpetra {
namespace Details {

namespace Impl {

// Implementation detail of create_mirror_view_from_raw_host_array
// (see below).
template<class ValueType,
         class OutputDeviceType,
         const bool constInput = std::is_const<ValueType>::value,
         const bool sameAsHost =
           std::is_same<Kokkos::HostSpace,
             typename OutputDeviceType::memory_space>::value>
class CreateMirrorViewFromUnmanagedHostArray {
public:
  typedef Kokkos::View<ValueType*, OutputDeviceType> output_view_type;
  typedef Kokkos::View<ValueType*,
                       typename output_view_type::array_layout,
                       Kokkos::HostSpace> input_view_type;
  static output_view_type
  doIt (ValueType* inPtr,
        const size_t inSize,
        const bool copy = true,
        const char label[] = "");
};

// Implementation detail of create_mirror_view_from_raw_host_array
// (see below).
template<class ValueType,
         class OutputDeviceType,
         const bool constInput>
class CreateMirrorViewFromUnmanagedHostArray<ValueType, OutputDeviceType, constInput, true> {
public:
  typedef Kokkos::View<ValueType*, OutputDeviceType> output_view_type;
  typedef Kokkos::View<ValueType*, typename output_view_type::array_layout,
                       Kokkos::HostSpace> input_view_type;
  static output_view_type
  doIt (ValueType* inPtr,
        const size_t inSize,
        const bool /* copy */,
        const char /* label */ [] = "")
  {
    static_assert (std::is_same<typename OutputDeviceType::memory_space,
                     Kokkos::HostSpace>::value,
                   "OutputDeviceType::memory_space must be the same as "
                   "Kokkos::HostSpace in order to use this specialization.  "
                   "Please report this bug to the Tpetra developers.");
    return output_view_type (inPtr, inSize);
  }
};

// Implementation detail of create_mirror_view_from_raw_host_array
// (see below).
template<class ValueType,
         class OutputDeviceType>
class CreateMirrorViewFromUnmanagedHostArray<ValueType, OutputDeviceType, true, false> {
public:
  typedef Kokkos::View<ValueType*, OutputDeviceType> output_view_type;
  typedef Kokkos::View<ValueType*, typename output_view_type::array_layout,
                       Kokkos::HostSpace> input_view_type;
  static output_view_type
  doIt (ValueType* inPtr,
        const size_t inSize,
        const bool copy = true,
        const char label[] = "")
  {
    using Kokkos::view_alloc;
    using Kokkos::WithoutInitializing;
    static_assert (std::is_const<ValueType>::value, "ValueType must be const "
                   "in order to use this specialization.  Please report this "
                   "bug to the Tpetra developers.");
    static_assert (! std::is_same<typename OutputDeviceType::memory_space, Kokkos::HostSpace>::value,
                   "OutputDeviceType::memory_space must not be the same as "
                   "Kokkos::HostSpace in order to use this specialization.  "
                   "Please report this bug to the Tpetra developers.");
    input_view_type inView (inPtr, inSize);
    // ValueType is const, so we have to strip away const first.
    typedef typename output_view_type::non_const_type nc_output_view_type;
    nc_output_view_type outView_nc;
    if (! copy) {
      // Label needs to be a string and not a char*, if given as an
      // argument to Kokkos::view_alloc.  This is because view_alloc
      // also allows a raw pointer as its first argument.  See
      // https://github.com/kokkos/kokkos/issues/434.
      outView_nc = nc_output_view_type (view_alloc (std::string (label)), inSize);
    }
    else {
      // No need to initialize, if we're going to copy into it anyway.
      outView_nc = nc_output_view_type (view_alloc (std::string (label), WithoutInitializing), inSize);
      Kokkos::deep_copy (outView_nc, inView);
    }
    return outView_nc; // this casts back to const
  }
};

// Implementation detail of create_mirror_view_from_raw_host_array
// (see below).
template<class ValueType,
         class OutputDeviceType>
class CreateMirrorViewFromUnmanagedHostArray<ValueType, OutputDeviceType, false, false> {
public:
  typedef Kokkos::View<ValueType*, OutputDeviceType> output_view_type;
  typedef Kokkos::View<ValueType*, typename output_view_type::array_layout,
                       Kokkos::HostSpace> input_view_type;
  static output_view_type
  doIt (ValueType* inPtr,
        const size_t inSize,
        const bool copy = true,
        const char label[] = "")
  {
    typedef typename OutputDeviceType::memory_space out_mem_space;
    static_assert (! std::is_const<ValueType>::value, "ValueType must not be "
                   "const in order to use this specialization.  Please report "
                   "this bug to the Tpetra developers.");
    static_assert (! std::is_same<out_mem_space, Kokkos::HostSpace>::value,
                   "OutputDeviceType::memory_space must not be the same as "
                   "Kokkos::HostSpace in order to use this specialization.  "
                   "Please report this bug to the Tpetra developers.");
    input_view_type inView (inPtr, inSize);
    output_view_type outView =
      Kokkos::create_mirror_view (out_mem_space (), inView);
    if (copy) {
      Kokkos::deep_copy (outView, inView);
    }
    return outView;
  }
};

} // namespace Impl

template<class ValueType, class OutputDeviceType>
typename Impl::CreateMirrorViewFromUnmanagedHostArray<ValueType, OutputDeviceType>::output_view_type
create_mirror_view_from_raw_host_array (const OutputDeviceType& /* dev */,
                                        ValueType* inPtr,
                                        const size_t inSize,
                                        const bool copy = true,
                                        const char label[] = "")
{
  typedef Impl::CreateMirrorViewFromUnmanagedHostArray<ValueType, OutputDeviceType> impl_type;
  return impl_type::doIt (inPtr, inSize, copy, label);
}

} // namespace Details
} // namespace Tpetra

#endif // TPETRA_DETAILS_CREATEMIRRORVIEW_HPP