ArrayCopyDevice.h

Go to the documentation of this file.

//============================================================================
//  The contents of this file are covered by the Viskores license. See
//  LICENSE.txt for details.
//
//  By contributing to this file, all contributors agree to the Developer
//  Certificate of Origin Version 1.1 (DCO 1.1) as stated in DCO.txt.
//============================================================================
 
//============================================================================
//  Copyright (c) Kitware, Inc.
//  All rights reserved.
//  See LICENSE.txt for details.
//
//  This software is distributed WITHOUT ANY WARRANTY; without even
//  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
//  PURPOSE.  See the above copyright notice for more information.
//============================================================================
#ifndef viskores_cont_ArrayCopyDevice_h
#define viskores_cont_ArrayCopyDevice_h
 
#include <viskores/cont/Algorithm.h>
#include <viskores/cont/ArrayHandle.h>
#include <viskores/cont/DeviceAdapterTag.h>
#include <viskores/cont/ErrorExecution.h>
#include <viskores/cont/Logging.h>
#include <viskores/cont/UnknownArrayHandle.h>
 
#include <viskores/cont/viskores_cont_export.h>
 
// TODO: When virtual arrays are available, compile the implementation in a .cxx/.cu file. Common
// arrays are copied directly but anything else would be copied through virtual methods.
 
namespace viskores
{
namespace cont
{
 
namespace detail
{
 
template <typename T1, typename S1, typename T2, typename S2>
VISKORES_CONT void ArrayCopyImpl(const viskores::cont::ArrayHandle<T1, S1>& source,
                                 viskores::cont::ArrayHandle<T2, S2>& destination)
{
  VISKORES_STATIC_ASSERT((!std::is_same<T1, T2>::value || !std::is_same<S1, S2>::value));
 
  // Current implementation of Algorithm::Copy will first try to copy on devices where the
  // data is already available.
  viskores::cont::Algorithm::Copy(source, destination);
}
 
template <typename T, typename S>
VISKORES_CONT void ArrayCopyImpl(const viskores::cont::ArrayHandle<T, S>& source,
                                 viskores::cont::ArrayHandle<T, S>& destination)
{
  destination.DeepCopyFrom(source);
}
 
} // namespace detail
 
template <typename InValueType, typename InStorage, typename OutValueType, typename OutStorage>
VISKORES_CONT void ArrayCopyDevice(
  const viskores::cont::ArrayHandle<InValueType, InStorage>& source,
  viskores::cont::ArrayHandle<OutValueType, OutStorage>& destination)
{
  using InArrayType = viskores::cont::ArrayHandle<InValueType, InStorage>;
  using OutArrayType = viskores::cont::ArrayHandle<OutValueType, OutStorage>;
  using SameTypes = std::is_same<InArrayType, OutArrayType>;
  using IsWritable = viskores::cont::internal::IsWritableArrayHandle<OutArrayType>;
 
  // There are three cases handled here:
  // 1. The arrays are the same type:
  //    -> Deep copy the buffers and the Storage object
  // 2. The arrays are different and the output is writable:
  //    -> Do element-wise copy
  // 3. The arrays are different and the output is not writable:
  //    -> fail (cannot copy)
 
  // Give a nice error message for case 3:
  VISKORES_STATIC_ASSERT_MSG(IsWritable::value || SameTypes::value,
                             "Cannot copy to a read-only array with a different "
                             "type than the source.");
 
  // Static dispatch cases 1 & 2
  detail::ArrayCopyImpl(source, destination);
}
 
 
}
} // namespace viskores::cont
 
#endif //viskores_cont_ArrayCopyDevice_h