mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-20 02:55:47 +00:00
c072e4ed29
Most `ArrayHandle` implementations must create an `std::vector<vtkm::cont::internal::Buffer>` object. It is most helpful to create it in the constructor when initializing the superclass (so the superclass does not have to create it's own). Added a `CreateBuffers` convenience function to make it easy to build these vectors.
453 lines
16 KiB
C++
453 lines
16 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_ArrayHandleCartesianProduct_h
|
|
#define vtk_m_cont_ArrayHandleCartesianProduct_h
|
|
|
|
#include <vtkm/Assert.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/ErrorBadAllocation.h>
|
|
#include <vtkm/cont/Token.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace internal
|
|
{
|
|
|
|
/// \brief An array portal that acts as a 3D cartesian product of 3 arrays.
|
|
///
|
|
template <typename ValueType_,
|
|
typename PortalTypeFirst_,
|
|
typename PortalTypeSecond_,
|
|
typename PortalTypeThird_>
|
|
class VTKM_ALWAYS_EXPORT ArrayPortalCartesianProduct
|
|
{
|
|
public:
|
|
using ValueType = ValueType_;
|
|
using IteratorType = ValueType_;
|
|
using PortalTypeFirst = PortalTypeFirst_;
|
|
using PortalTypeSecond = PortalTypeSecond_;
|
|
using PortalTypeThird = PortalTypeThird_;
|
|
|
|
using set_supported_p1 = vtkm::internal::PortalSupportsSets<PortalTypeFirst>;
|
|
using set_supported_p2 = vtkm::internal::PortalSupportsSets<PortalTypeSecond>;
|
|
using set_supported_p3 = vtkm::internal::PortalSupportsSets<PortalTypeThird>;
|
|
|
|
using Writable = std::integral_constant<bool,
|
|
set_supported_p1::value && set_supported_p2::value &&
|
|
set_supported_p3::value>;
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ArrayPortalCartesianProduct()
|
|
: PortalFirst()
|
|
, PortalSecond()
|
|
, PortalThird()
|
|
{
|
|
} //needs to be host and device so that cuda can create lvalue of these
|
|
|
|
VTKM_CONT
|
|
ArrayPortalCartesianProduct(const PortalTypeFirst& portalfirst,
|
|
const PortalTypeSecond& portalsecond,
|
|
const PortalTypeThird& portalthird)
|
|
: PortalFirst(portalfirst)
|
|
, PortalSecond(portalsecond)
|
|
, PortalThird(portalthird)
|
|
{
|
|
}
|
|
|
|
/// Copy constructor for any other ArrayPortalCartesianProduct with an iterator
|
|
/// type that can be copied to this iterator type. This allows us to do any
|
|
/// type casting that the iterators do (like the non-const to const cast).
|
|
///
|
|
|
|
template <class OtherV, class OtherP1, class OtherP2, class OtherP3>
|
|
VTKM_CONT ArrayPortalCartesianProduct(
|
|
const ArrayPortalCartesianProduct<OtherV, OtherP1, OtherP2, OtherP3>& src)
|
|
: PortalFirst(src.GetPortalFirst())
|
|
, PortalSecond(src.GetPortalSecond())
|
|
, PortalThird(src.GetPortalThird())
|
|
{
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
vtkm::Id GetNumberOfValues() const
|
|
{
|
|
return this->PortalFirst.GetNumberOfValues() * this->PortalSecond.GetNumberOfValues() *
|
|
this->PortalThird.GetNumberOfValues();
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
ValueType Get(vtkm::Id index) const
|
|
{
|
|
VTKM_ASSERT(index >= 0);
|
|
VTKM_ASSERT(index < this->GetNumberOfValues());
|
|
|
|
vtkm::Id dim1 = this->PortalFirst.GetNumberOfValues();
|
|
vtkm::Id dim2 = this->PortalSecond.GetNumberOfValues();
|
|
vtkm::Id dim12 = dim1 * dim2;
|
|
vtkm::Id idx12 = index % dim12;
|
|
vtkm::Id i1 = idx12 % dim1;
|
|
vtkm::Id i2 = idx12 / dim1;
|
|
vtkm::Id i3 = index / dim12;
|
|
|
|
return vtkm::make_Vec(
|
|
this->PortalFirst.Get(i1), this->PortalSecond.Get(i2), this->PortalThird.Get(i3));
|
|
}
|
|
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
template <typename Writable_ = Writable,
|
|
typename = typename std::enable_if<Writable_::value>::type>
|
|
VTKM_EXEC_CONT void Set(vtkm::Id index, const ValueType& value) const
|
|
{
|
|
VTKM_ASSERT(index >= 0);
|
|
VTKM_ASSERT(index < this->GetNumberOfValues());
|
|
|
|
vtkm::Id dim1 = this->PortalFirst.GetNumberOfValues();
|
|
vtkm::Id dim2 = this->PortalSecond.GetNumberOfValues();
|
|
vtkm::Id dim12 = dim1 * dim2;
|
|
vtkm::Id idx12 = index % dim12;
|
|
|
|
vtkm::Id i1 = idx12 % dim1;
|
|
vtkm::Id i2 = idx12 / dim1;
|
|
vtkm::Id i3 = index / dim12;
|
|
|
|
this->PortalFirst.Set(i1, value[0]);
|
|
this->PortalSecond.Set(i2, value[1]);
|
|
this->PortalThird.Set(i3, value[2]);
|
|
}
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
const PortalTypeFirst& GetFirstPortal() const { return this->PortalFirst; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
const PortalTypeSecond& GetSecondPortal() const { return this->PortalSecond; }
|
|
|
|
VTKM_SUPPRESS_EXEC_WARNINGS
|
|
VTKM_EXEC_CONT
|
|
const PortalTypeThird& GetThirdPortal() const { return this->PortalThird; }
|
|
|
|
private:
|
|
PortalTypeFirst PortalFirst;
|
|
PortalTypeSecond PortalSecond;
|
|
PortalTypeThird PortalThird;
|
|
};
|
|
}
|
|
} // namespace vtkm::internal
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
template <typename StorageTag1, typename StorageTag2, typename StorageTag3>
|
|
struct VTKM_ALWAYS_EXPORT StorageTagCartesianProduct
|
|
{
|
|
};
|
|
|
|
namespace internal
|
|
{
|
|
|
|
/// This helper struct defines the value type for a zip container containing
|
|
/// the given two array handles.
|
|
///
|
|
template <typename AH1, typename AH2, typename AH3>
|
|
struct ArrayHandleCartesianProductTraits
|
|
{
|
|
VTKM_IS_ARRAY_HANDLE(AH1);
|
|
VTKM_IS_ARRAY_HANDLE(AH2);
|
|
VTKM_IS_ARRAY_HANDLE(AH3);
|
|
|
|
using ComponentType = typename AH1::ValueType;
|
|
VTKM_STATIC_ASSERT_MSG(
|
|
(std::is_same<ComponentType, typename AH2::ValueType>::value),
|
|
"All arrays for ArrayHandleCartesianProduct must have the same value type. "
|
|
"Use ArrayHandleCast as necessary to make types match.");
|
|
VTKM_STATIC_ASSERT_MSG(
|
|
(std::is_same<ComponentType, typename AH3::ValueType>::value),
|
|
"All arrays for ArrayHandleCartesianProduct must have the same value type. "
|
|
"Use ArrayHandleCast as necessary to make types match.");
|
|
|
|
/// The ValueType (a pair containing the value types of the two arrays).
|
|
///
|
|
using ValueType = vtkm::Vec<ComponentType, 3>;
|
|
|
|
/// The appropriately templated tag.
|
|
///
|
|
using Tag = vtkm::cont::StorageTagCartesianProduct<typename AH1::StorageTag,
|
|
typename AH2::StorageTag,
|
|
typename AH3::StorageTag>;
|
|
|
|
/// The superclass for ArrayHandleCartesianProduct.
|
|
///
|
|
using Superclass = vtkm::cont::ArrayHandle<ValueType, Tag>;
|
|
};
|
|
|
|
template <typename T, typename ST1, typename ST2, typename ST3>
|
|
class Storage<vtkm::Vec<T, 3>, vtkm::cont::StorageTagCartesianProduct<ST1, ST2, ST3>>
|
|
{
|
|
using Storage1 = vtkm::cont::internal::Storage<T, ST1>;
|
|
using Storage2 = vtkm::cont::internal::Storage<T, ST2>;
|
|
using Storage3 = vtkm::cont::internal::Storage<T, ST3>;
|
|
|
|
template <typename Buffs>
|
|
VTKM_CONT constexpr static Buffs* Buffers1(Buffs* buffers)
|
|
{
|
|
return buffers;
|
|
}
|
|
|
|
template <typename Buffs>
|
|
VTKM_CONT constexpr static Buffs* Buffers2(Buffs* buffers)
|
|
{
|
|
return buffers + Storage1::GetNumberOfBuffers();
|
|
}
|
|
|
|
template <typename Buffs>
|
|
VTKM_CONT constexpr static Buffs* Buffers3(Buffs* buffers)
|
|
{
|
|
return buffers + Storage1::GetNumberOfBuffers() + Storage2::GetNumberOfBuffers();
|
|
}
|
|
|
|
public:
|
|
using ReadPortalType =
|
|
vtkm::internal::ArrayPortalCartesianProduct<vtkm::Vec<T, 3>,
|
|
typename Storage1::ReadPortalType,
|
|
typename Storage2::ReadPortalType,
|
|
typename Storage3::ReadPortalType>;
|
|
using WritePortalType =
|
|
vtkm::internal::ArrayPortalCartesianProduct<vtkm::Vec<T, 3>,
|
|
typename Storage1::WritePortalType,
|
|
typename Storage2::WritePortalType,
|
|
typename Storage3::WritePortalType>;
|
|
|
|
VTKM_CONT constexpr static vtkm::IdComponent GetNumberOfBuffers()
|
|
{
|
|
return Storage1::GetNumberOfBuffers() + Storage2::GetNumberOfBuffers() +
|
|
Storage3::GetNumberOfBuffers();
|
|
}
|
|
|
|
VTKM_CONT static vtkm::Id GetNumberOfValues(const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return (Storage1::GetNumberOfValues(Buffers1(buffers)) *
|
|
Storage2::GetNumberOfValues(Buffers2(buffers)) *
|
|
Storage3::GetNumberOfValues(Buffers3(buffers)));
|
|
}
|
|
|
|
VTKM_CONT static void ResizeBuffers(vtkm::Id numValues,
|
|
vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::CopyFlag vtkmNotUsed(preserve),
|
|
vtkm::cont::Token& vtkmNotUsed(token))
|
|
{
|
|
if (numValues == GetNumberOfValues(buffers))
|
|
{
|
|
// In general, we don't allow resizing of the array, but if it was "allocated" to the
|
|
// correct size, we will allow that.
|
|
}
|
|
else
|
|
{
|
|
throw vtkm::cont::ErrorBadAllocation("Does not make sense.");
|
|
}
|
|
}
|
|
|
|
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return ReadPortalType(Storage1::CreateReadPortal(Buffers1(buffers), device, token),
|
|
Storage2::CreateReadPortal(Buffers2(buffers), device, token),
|
|
Storage3::CreateReadPortal(Buffers3(buffers), device, token));
|
|
}
|
|
|
|
VTKM_CONT static WritePortalType CreateWritePortal(vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return WritePortalType(Storage1::CreateWritePortal(Buffers1(buffers), device, token),
|
|
Storage2::CreateWritePortal(Buffers2(buffers), device, token),
|
|
Storage3::CreateWritePortal(Buffers3(buffers), device, token));
|
|
}
|
|
|
|
VTKM_CONT static vtkm::cont::ArrayHandle<T, ST1> GetArrayHandle1(
|
|
const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return vtkm::cont::ArrayHandle<T, ST1>(Buffers1(buffers));
|
|
}
|
|
VTKM_CONT static vtkm::cont::ArrayHandle<T, ST2> GetArrayHandle2(
|
|
const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return vtkm::cont::ArrayHandle<T, ST2>(Buffers2(buffers));
|
|
}
|
|
VTKM_CONT static vtkm::cont::ArrayHandle<T, ST3> GetArrayHandle3(
|
|
const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return vtkm::cont::ArrayHandle<T, ST3>(Buffers3(buffers));
|
|
}
|
|
};
|
|
} // namespace internal
|
|
|
|
template <typename T, typename ST1, typename ST2, typename ST3>
|
|
VTKM_ARRAY_HANDLE_NEW_STYLE(
|
|
T,
|
|
VTKM_PASS_COMMAS(vtkm::cont::StorageTagCartesianProduct<ST1, ST2, ST3>));
|
|
|
|
/// ArrayHandleCartesianProduct is a specialization of ArrayHandle. It takes two delegate
|
|
/// array handle and makes a new handle that access the corresponding entries
|
|
/// in these arrays as a pair.
|
|
///
|
|
template <typename FirstHandleType, typename SecondHandleType, typename ThirdHandleType>
|
|
class ArrayHandleCartesianProduct
|
|
: public internal::ArrayHandleCartesianProductTraits<FirstHandleType,
|
|
SecondHandleType,
|
|
ThirdHandleType>::Superclass
|
|
{
|
|
// If the following line gives a compile error, then the FirstHandleType
|
|
// template argument is not a valid ArrayHandle type.
|
|
VTKM_IS_ARRAY_HANDLE(FirstHandleType);
|
|
VTKM_IS_ARRAY_HANDLE(SecondHandleType);
|
|
VTKM_IS_ARRAY_HANDLE(ThirdHandleType);
|
|
|
|
public:
|
|
VTKM_ARRAY_HANDLE_SUBCLASS(
|
|
ArrayHandleCartesianProduct,
|
|
(ArrayHandleCartesianProduct<FirstHandleType, SecondHandleType, ThirdHandleType>),
|
|
(typename internal::ArrayHandleCartesianProductTraits<FirstHandleType,
|
|
SecondHandleType,
|
|
ThirdHandleType>::Superclass));
|
|
|
|
private:
|
|
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
|
|
|
|
public:
|
|
VTKM_CONT
|
|
ArrayHandleCartesianProduct(const FirstHandleType& firstArray,
|
|
const SecondHandleType& secondArray,
|
|
const ThirdHandleType& thirdArray)
|
|
: Superclass(vtkm::cont::internal::CreateBuffers(firstArray, secondArray, thirdArray))
|
|
{
|
|
}
|
|
|
|
/// Implemented so that it is defined exclusively in the control environment.
|
|
/// If there is a separate device for the execution environment (for example,
|
|
/// with CUDA), then the automatically generated destructor could be
|
|
/// created for all devices, and it would not be valid for all devices.
|
|
///
|
|
~ArrayHandleCartesianProduct() {}
|
|
|
|
VTKM_CONT FirstHandleType GetFirstArray() const
|
|
{
|
|
return StorageType::GetArrayHandle1(this->GetBuffers());
|
|
}
|
|
VTKM_CONT SecondHandleType GetSecondArray() const
|
|
{
|
|
return StorageType::GetArrayHandle2(this->GetBuffers());
|
|
}
|
|
VTKM_CONT ThirdHandleType GetThirdArray() const
|
|
{
|
|
return StorageType::GetArrayHandle3(this->GetBuffers());
|
|
}
|
|
};
|
|
|
|
/// A convenience function for creating an ArrayHandleCartesianProduct. It takes the two
|
|
/// arrays to be zipped together.
|
|
///
|
|
template <typename FirstHandleType, typename SecondHandleType, typename ThirdHandleType>
|
|
VTKM_CONT
|
|
vtkm::cont::ArrayHandleCartesianProduct<FirstHandleType, SecondHandleType, ThirdHandleType>
|
|
make_ArrayHandleCartesianProduct(const FirstHandleType& first,
|
|
const SecondHandleType& second,
|
|
const ThirdHandleType& third)
|
|
{
|
|
return ArrayHandleCartesianProduct<FirstHandleType, SecondHandleType, ThirdHandleType>(
|
|
first, second, third);
|
|
}
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
//=============================================================================
|
|
// Specializations of serialization related classes
|
|
/// @cond SERIALIZATION
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
template <typename AH1, typename AH2, typename AH3>
|
|
struct SerializableTypeString<vtkm::cont::ArrayHandleCartesianProduct<AH1, AH2, AH3>>
|
|
{
|
|
static VTKM_CONT const std::string& Get()
|
|
{
|
|
static std::string name = "AH_CartesianProduct<" + SerializableTypeString<AH1>::Get() + "," +
|
|
SerializableTypeString<AH2>::Get() + "," + SerializableTypeString<AH3>::Get() + ">";
|
|
return name;
|
|
}
|
|
};
|
|
|
|
template <typename T, typename ST1, typename ST2, typename ST3>
|
|
struct SerializableTypeString<
|
|
vtkm::cont::ArrayHandle<vtkm::Vec<T, 3>, vtkm::cont::StorageTagCartesianProduct<ST1, ST2, ST3>>>
|
|
: SerializableTypeString<vtkm::cont::ArrayHandleCartesianProduct<vtkm::cont::ArrayHandle<T, ST1>,
|
|
vtkm::cont::ArrayHandle<T, ST2>,
|
|
vtkm::cont::ArrayHandle<T, ST3>>>
|
|
{
|
|
};
|
|
}
|
|
} // vtkm::cont
|
|
|
|
namespace mangled_diy_namespace
|
|
{
|
|
|
|
template <typename AH1, typename AH2, typename AH3>
|
|
struct Serialization<vtkm::cont::ArrayHandleCartesianProduct<AH1, AH2, AH3>>
|
|
{
|
|
private:
|
|
using Type = typename vtkm::cont::ArrayHandleCartesianProduct<AH1, AH2, AH3>;
|
|
using BaseType = vtkm::cont::ArrayHandle<typename Type::ValueType, typename Type::StorageTag>;
|
|
|
|
public:
|
|
static VTKM_CONT void save(BinaryBuffer& bb, const BaseType& obj)
|
|
{
|
|
Type array = obj;
|
|
vtkmdiy::save(bb, array.GetFirstArray());
|
|
vtkmdiy::save(bb, array.GetSecondArray());
|
|
vtkmdiy::save(bb, array.GetThirdArray());
|
|
}
|
|
|
|
static VTKM_CONT void load(BinaryBuffer& bb, BaseType& obj)
|
|
{
|
|
AH1 array1;
|
|
AH2 array2;
|
|
AH3 array3;
|
|
|
|
vtkmdiy::load(bb, array1);
|
|
vtkmdiy::load(bb, array2);
|
|
vtkmdiy::load(bb, array3);
|
|
|
|
obj = vtkm::cont::make_ArrayHandleCartesianProduct(array1, array2, array3);
|
|
}
|
|
};
|
|
|
|
template <typename T, typename ST1, typename ST2, typename ST3>
|
|
struct Serialization<
|
|
vtkm::cont::ArrayHandle<vtkm::Vec<T, 3>, vtkm::cont::StorageTagCartesianProduct<ST1, ST2, ST3>>>
|
|
: Serialization<vtkm::cont::ArrayHandleCartesianProduct<vtkm::cont::ArrayHandle<T, ST1>,
|
|
vtkm::cont::ArrayHandle<T, ST2>,
|
|
vtkm::cont::ArrayHandle<T, ST3>>>
|
|
{
|
|
};
|
|
} // diy
|
|
/// @endcond SERIALIZATION
|
|
|
|
#endif //vtk_m_cont_ArrayHandleCartesianProduct_h
|