e740934700
Added the following form of `ArrayCopy`: ```cpp VTKM_CONT_EXPORT void ArrayCopy( const vtkm::cont::UnknownArrayHandle& source, const vtkm::cont::UnknownArrayHandle& destination); ``` Note that the destination array is a constant reference. This is actually OK because you can change the contents of an `UnknownArrayHandle` (as long as you don't change the array being referenced). The main motivation for this change is to allow you to call this form of `ArrayCopy` while passing in a `ArrayHandle` as the second argument. C++ will automatically make the conversion, but the function has to accept a const reference for it to be passed correctly. Note that there is still a form of `ArrayCopy` that accepts a non-const reference to the destination array. The two arrays behave the same except for one difference. For the non-const version, if the `UnknownArrayHandle` does not already point to an array (i.e. is not valid), a new array will be created and placed in the destination object. However, because this cannot be done for a const reference, an exception is thrown instead.
203 lines
7.8 KiB
C++
203 lines
7.8 KiB
C++
//============================================================================
|
|
// 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 vtk_m_cont_ArrayCopy_h
|
|
#define vtk_m_cont_ArrayCopy_h
|
|
|
|
#include <vtkm/cont/Algorithm.h>
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/DeviceAdapterTag.h>
|
|
#include <vtkm/cont/ErrorExecution.h>
|
|
#include <vtkm/cont/Logging.h>
|
|
#include <vtkm/cont/UnknownArrayHandle.h>
|
|
|
|
#include <vtkm/cont/internal/ArrayHandleDeprecated.h>
|
|
|
|
#include <vtkm/cont/vtkm_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 vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
namespace detail
|
|
{
|
|
|
|
// Element-wise copy.
|
|
template <typename InArrayType, typename OutArrayType>
|
|
void ArrayCopyWithAlgorithm(const InArrayType& source, OutArrayType& destination)
|
|
{
|
|
// Current implementation of Algorithm::Copy will first try to copy on devices where the
|
|
// data is already available.
|
|
vtkm::cont::Algorithm::Copy(source, destination);
|
|
}
|
|
|
|
// TODO: Remove last argument once ArryHandleNewStyle becomes ArrayHandle
|
|
template <typename InArrayType, typename OutArrayType>
|
|
void ArrayCopyOldImpl(const InArrayType& in, OutArrayType& out, std::false_type /* Copy storage */)
|
|
{
|
|
ArrayCopyWithAlgorithm(in, out);
|
|
}
|
|
|
|
// Copy storage for implicit arrays, must be of same type:
|
|
// TODO: This will go away once ArrayHandleNewStyle becomes ArrayHandle.
|
|
template <typename ArrayType>
|
|
void ArrayCopyOldImpl(const ArrayType& in, ArrayType& out, std::true_type /* Copy storage */)
|
|
{
|
|
// This is only called if in/out are the same type and the handle is not
|
|
// writable. This allows read-only implicit array handles to be copied.
|
|
auto newStorage = in.GetStorage();
|
|
out = ArrayType(newStorage);
|
|
}
|
|
|
|
// TODO: This will go away once ArrayHandleNewStyle becomes ArrayHandle.
|
|
template <typename InArrayType, typename OutArrayType>
|
|
VTKM_CONT void ArrayCopyImpl(const InArrayType& source,
|
|
OutArrayType& destination,
|
|
std::false_type /* New style */)
|
|
{
|
|
using SameTypes = std::is_same<InArrayType, OutArrayType>;
|
|
using IsWritable = vtkm::cont::internal::IsWritableArrayHandle<OutArrayType>;
|
|
using JustCopyStorage = std::integral_constant<bool, SameTypes::value && !IsWritable::value>;
|
|
ArrayCopyOldImpl(source, destination, JustCopyStorage{});
|
|
}
|
|
|
|
// TODO: ArrayHandleNewStyle will eventually become ArrayHandle, in which case this
|
|
// will become ArrayCopyWithAlgorithm
|
|
template <typename T1, typename S1, typename T2, typename S2>
|
|
VTKM_CONT void ArrayCopyImpl(const vtkm::cont::ArrayHandle<T1, S1>& source,
|
|
vtkm::cont::ArrayHandle<T2, S2>& destination,
|
|
std::true_type /* New style */)
|
|
{
|
|
VTKM_STATIC_ASSERT((!std::is_same<T1, T2>::value || !std::is_same<S1, S2>::value));
|
|
ArrayCopyWithAlgorithm(source, destination);
|
|
}
|
|
|
|
// TODO: ArrayHandleNewStyle will eventually become ArrayHandle, in which case this
|
|
// will become the only version with the same array types.
|
|
template <typename T, typename S>
|
|
VTKM_CONT void ArrayCopyImpl(const vtkm::cont::ArrayHandle<T, S>& source,
|
|
vtkm::cont::ArrayHandle<T, S>& destination,
|
|
std::true_type /* New style */)
|
|
{
|
|
destination.DeepCopyFrom(source);
|
|
}
|
|
|
|
} // namespace detail
|
|
|
|
/// \brief Does a deep copy from one array to another array.
|
|
///
|
|
/// Given a source \c ArrayHandle and a destination \c ArrayHandle, this
|
|
/// function allocates the destination \c ArrayHandle to the correct size and
|
|
/// deeply copies all the values from the source to the destination.
|
|
///
|
|
/// This method will attempt to copy the data using the device that the input
|
|
/// data is already valid on. If the input data is only valid in the control
|
|
/// environment, the runtime device tracker is used to try to find another
|
|
/// device.
|
|
///
|
|
/// This should work on some non-writable array handles as well, as long as
|
|
/// both \a source and \a destination are the same type.
|
|
///
|
|
/// @{
|
|
///
|
|
template <typename InValueType, typename InStorage, typename OutValueType, typename OutStorage>
|
|
VTKM_CONT void ArrayCopy(const vtkm::cont::ArrayHandle<InValueType, InStorage>& source,
|
|
vtkm::cont::ArrayHandle<OutValueType, OutStorage>& destination)
|
|
{
|
|
using InArrayType = vtkm::cont::ArrayHandle<InValueType, InStorage>;
|
|
using OutArrayType = vtkm::cont::ArrayHandle<OutValueType, OutStorage>;
|
|
using SameTypes = std::is_same<InArrayType, OutArrayType>;
|
|
using IsWritable = vtkm::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:
|
|
VTKM_STATIC_ASSERT_MSG(IsWritable::value || SameTypes::value,
|
|
"Cannot copy to a read-only array with a different "
|
|
"type than the source.");
|
|
|
|
using IsOldStyle =
|
|
std::is_base_of<vtkm::cont::internal::ArrayHandleDeprecated<InValueType, InStorage>,
|
|
InArrayType>;
|
|
|
|
// Static dispatch cases 1 & 2
|
|
detail::ArrayCopyImpl(source, destination, std::integral_constant<bool, !IsOldStyle::value>{});
|
|
}
|
|
|
|
|
|
VTKM_CONT_EXPORT void ArrayCopy(const vtkm::cont::UnknownArrayHandle& source,
|
|
vtkm::cont::UnknownArrayHandle& destination);
|
|
|
|
VTKM_CONT_EXPORT void ArrayCopy(const vtkm::cont::UnknownArrayHandle& source,
|
|
const vtkm::cont::UnknownArrayHandle& destination);
|
|
|
|
template <typename T, typename S>
|
|
VTKM_CONT void ArrayCopy(const vtkm::cont::UnknownArrayHandle& source,
|
|
vtkm::cont::ArrayHandle<T, S>& destination)
|
|
{
|
|
using DestType = vtkm::cont::ArrayHandle<T, S>;
|
|
if (source.CanConvert<DestType>())
|
|
{
|
|
ArrayCopy(source.AsArrayHandle<DestType>(), destination);
|
|
}
|
|
else
|
|
{
|
|
vtkm::cont::UnknownArrayHandle destWrapper(destination);
|
|
ArrayCopy(source, destWrapper);
|
|
// Destination array should not change, but just in case.
|
|
destWrapper.AsArrayHandle(destination);
|
|
}
|
|
}
|
|
|
|
/// @}
|
|
|
|
/// \brief Copies from an unknown to a known array type.
|
|
///
|
|
/// Often times you have an array of an unknown type (likely from a data set),
|
|
/// and you need it to be of a particular type (or can make a reasonable but uncertain
|
|
/// assumption about it being a particular type). You really just want a shallow
|
|
/// copy (a reference in a concrete `ArrayHandle`) if that is possible.
|
|
///
|
|
/// `ArrayCopyShallowIfPossible` pulls an array of a specific type from an
|
|
/// `UnknownArrayHandle`. If the type is compatible, it will perform a shallow copy.
|
|
/// If it is not possible, a deep copy is performed to get it to the correct type.
|
|
///
|
|
template <typename T, typename S>
|
|
VTKM_CONT void ArrayCopyShallowIfPossible(const vtkm::cont::UnknownArrayHandle source,
|
|
vtkm::cont::ArrayHandle<T, S>& destination)
|
|
{
|
|
using DestType = vtkm::cont::ArrayHandle<T, S>;
|
|
if (source.CanConvert<DestType>())
|
|
{
|
|
source.AsArrayHandle(destination);
|
|
}
|
|
else
|
|
{
|
|
vtkm::cont::UnknownArrayHandle destWrapper(destination);
|
|
ArrayCopy(source, destWrapper);
|
|
// Destination array should not change, but just in case.
|
|
destWrapper.AsArrayHandle(destination);
|
|
}
|
|
}
|
|
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_ArrayCopy_h
|