mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 21:33:55 +00:00
b2daec0e35
The tao ones won't compile otherwise. This should be okay, since these are all just compile time helpers on host-only functions -- they won't generate different sized data structures etc if we mix them in the same build.
898 lines
34 KiB
C++
898 lines
34 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_ArrayHandleDecorator_h
|
|
#define vtk_m_ArrayHandleDecorator_h
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/Storage.h>
|
|
|
|
#include <vtkm/StaticAssert.h>
|
|
#include <vtkm/VecTraits.h>
|
|
|
|
#include <vtkm/internal/ArrayPortalHelpers.h>
|
|
#include <vtkm/internal/brigand.hpp>
|
|
|
|
#include <vtkmtaotuple/include/Tuple.h>
|
|
#include <vtkmtaotuple/include/tao/seq/make_integer_sequence.hpp>
|
|
|
|
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
// MSVC < 2019 and CUDA have issues with tao integer sequences
|
|
#if (defined(VTKM_MSVC) && (_MSC_VER < 1920)) || defined(VTKM_CUDA_DEVICE_PASS)
|
|
#define VTKM_USE_BRIGAND_SEQ
|
|
#endif
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
namespace internal
|
|
{
|
|
|
|
namespace decor
|
|
{
|
|
|
|
// Generic InverseFunctor implementation that does nothing.
|
|
struct NoOpInverseFunctor
|
|
{
|
|
NoOpInverseFunctor() = default;
|
|
template <typename... Ts>
|
|
VTKM_EXEC_CONT NoOpInverseFunctor(Ts...)
|
|
{
|
|
}
|
|
template <typename VT>
|
|
VTKM_EXEC_CONT void operator()(vtkm::Id, VT) const
|
|
{
|
|
}
|
|
};
|
|
|
|
} // namespace decor
|
|
|
|
// The portal for ArrayHandleDecorator. Get calls FunctorType::operator(), and
|
|
// Set calls InverseFunctorType::operator(), but only if the DecoratorImpl
|
|
// provides an inverse.
|
|
template <typename ValueType_, typename FunctorType_, typename InverseFunctorType_>
|
|
class VTKM_ALWAYS_EXPORT ArrayPortalDecorator
|
|
{
|
|
public:
|
|
using ValueType = ValueType_;
|
|
using FunctorType = FunctorType_;
|
|
using InverseFunctorType = InverseFunctorType_;
|
|
using ReadOnly = std::is_same<InverseFunctorType, decor::NoOpInverseFunctor>;
|
|
|
|
VTKM_EXEC_CONT
|
|
ArrayPortalDecorator() {}
|
|
|
|
VTKM_CONT
|
|
ArrayPortalDecorator(FunctorType func, InverseFunctorType iFunc, vtkm::Id numValues)
|
|
: Functor(func)
|
|
, InverseFunctor(iFunc)
|
|
, NumberOfValues(numValues)
|
|
{
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
|
vtkm::Id GetNumberOfValues() const { return this->NumberOfValues; }
|
|
|
|
VTKM_EXEC_CONT
|
|
ValueType Get(vtkm::Id index) const { return this->Functor(index); }
|
|
|
|
template <typename ReadOnly_ = ReadOnly,
|
|
typename = typename std::enable_if<!ReadOnly_::value>::type>
|
|
VTKM_EXEC_CONT void Set(vtkm::Id index, const ValueType& value) const
|
|
{
|
|
this->InverseFunctor(index, value);
|
|
}
|
|
|
|
private:
|
|
FunctorType Functor;
|
|
InverseFunctorType InverseFunctor;
|
|
vtkm::Id NumberOfValues;
|
|
};
|
|
|
|
namespace decor
|
|
{
|
|
|
|
// Ensures that all types in variadic container ArrayHandleList are subclasses
|
|
// of ArrayHandleBase.
|
|
template <typename ArrayHandleList>
|
|
using AllAreArrayHandles =
|
|
brigand::all<ArrayHandleList, std::is_base_of<ArrayHandleBase, brigand::_1>>;
|
|
|
|
namespace detail
|
|
{
|
|
|
|
// Tests whether DecoratorImplT has a CreateInverseFunctor(Portals...) method.
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
struct IsFunctorInvertibleImpl;
|
|
|
|
template <typename DecoratorImplT, template <typename...> class List, typename... PortalTs>
|
|
struct IsFunctorInvertibleImpl<DecoratorImplT, List<PortalTs...>>
|
|
{
|
|
private:
|
|
using PortalList = brigand::list<typename std::decay<PortalTs>::type...>;
|
|
|
|
template <
|
|
typename T,
|
|
typename U = decltype(std::declval<T>().CreateInverseFunctor(std::declval<PortalTs>()...))>
|
|
static std::true_type InverseExistsTest(int);
|
|
|
|
template <typename T>
|
|
static std::false_type InverseExistsTest(...);
|
|
|
|
public:
|
|
using type = decltype(InverseExistsTest<DecoratorImplT>(0));
|
|
};
|
|
|
|
// Deduces the type returned by DecoratorImplT::CreateFunctor when given
|
|
// the specified portals.
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
struct GetFunctorTypeImpl;
|
|
|
|
template <typename DecoratorImplT, template <typename...> class List, typename... PortalTs>
|
|
struct GetFunctorTypeImpl<DecoratorImplT, List<PortalTs...>>
|
|
{
|
|
using type = decltype(std::declval<DecoratorImplT>().CreateFunctor(std::declval<PortalTs>()...));
|
|
};
|
|
|
|
// Deduces the type returned by DecoratorImplT::CreateInverseFunctor when given
|
|
// the specified portals. If DecoratorImplT doesn't have a CreateInverseFunctor
|
|
// method, a NoOp functor will be used instead.
|
|
template <typename CanWrite, typename DecoratorImplT, typename PortalList>
|
|
struct GetInverseFunctorTypeImpl;
|
|
|
|
template <typename DecoratorImplT, template <typename...> class List, typename... PortalTs>
|
|
struct GetInverseFunctorTypeImpl<std::true_type, DecoratorImplT, List<PortalTs...>>
|
|
{
|
|
using type =
|
|
decltype(std::declval<DecoratorImplT>().CreateInverseFunctor(std::declval<PortalTs>()...));
|
|
};
|
|
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
struct GetInverseFunctorTypeImpl<std::false_type, DecoratorImplT, PortalList>
|
|
{
|
|
using type = NoOpInverseFunctor;
|
|
};
|
|
|
|
// Get appropriate portals from a source array.
|
|
// See note below about using non-writable portals in invertible functors.
|
|
// We need to sub in const portals when writable ones don't exist.
|
|
template <typename ArrayT>
|
|
typename std::decay<ArrayT>::type::PortalControl GetPortalControlImpl(std::true_type,
|
|
ArrayT&& array)
|
|
{
|
|
return array.GetPortalControl();
|
|
}
|
|
|
|
template <typename ArrayT>
|
|
typename std::decay<ArrayT>::type::PortalConstControl GetPortalControlImpl(std::false_type,
|
|
ArrayT&& array)
|
|
{
|
|
return array.GetPortalConstControl();
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::Portal
|
|
GetPortalInPlaceImpl(std::true_type, ArrayT&& array, Device)
|
|
{
|
|
return array.PrepareForInPlace(Device{});
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::PortalConst
|
|
GetPortalInPlaceImpl(std::false_type, ArrayT&& array, Device)
|
|
{
|
|
// ArrayT is read-only -- prepare for input instead.
|
|
return array.PrepareForInput(Device{});
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::Portal
|
|
GetPortalOutputImpl(std::true_type, ArrayT&& array, Device)
|
|
{
|
|
// Prepare these for inplace usage instead -- we'll likely need to read
|
|
// from these in addition to writing.
|
|
return array.PrepareForInPlace(Device{});
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::PortalConst
|
|
GetPortalOutputImpl(std::false_type, ArrayT&& array, Device)
|
|
{
|
|
// ArrayT is read-only -- prepare for input instead.
|
|
return array.PrepareForInput(Device{});
|
|
}
|
|
|
|
} // namespace detail
|
|
|
|
// Get portal types:
|
|
// We allow writing to an AHDecorator if *any* of the ArrayHandles are writable.
|
|
// This means we have to avoid calling PrepareForOutput, etc on non-writable
|
|
// array handles, since these may throw. On non-writable handles, use the
|
|
// const array handles so we can at least read from them in the inverse
|
|
// functors.
|
|
template <typename ArrayT,
|
|
typename Portal = typename std::decay<ArrayT>::type::PortalControl,
|
|
typename PortalConst = typename std::decay<ArrayT>::type::PortalConstControl>
|
|
using GetPortalControlType =
|
|
typename brigand::if_<vtkm::internal::PortalSupportsSets<Portal>, Portal, PortalConst>::type;
|
|
|
|
template <typename ArrayT>
|
|
using GetPortalConstControlType = typename std::decay<ArrayT>::type::PortalConstControl;
|
|
|
|
template <typename ArrayT,
|
|
typename Device,
|
|
typename Portal =
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::Portal,
|
|
typename PortalConst =
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::PortalConst>
|
|
using GetPortalExecutionType =
|
|
typename brigand::if_<vtkm::internal::PortalSupportsSets<Portal>, Portal, PortalConst>::type;
|
|
|
|
template <typename ArrayT, typename Device>
|
|
using GetPortalConstExecutionType =
|
|
typename std::decay<ArrayT>::type::template ExecutionTypes<Device>::PortalConst;
|
|
|
|
// Get portal objects:
|
|
// See note above -- we swap in const portals sometimes.
|
|
template <typename ArrayT>
|
|
GetPortalControlType<typename std::decay<ArrayT>::type> GetPortalControl(ArrayT&& array)
|
|
{
|
|
return detail::GetPortalControlImpl(IsWritableArrayHandle<ArrayT>{}, std::forward<ArrayT>(array));
|
|
}
|
|
|
|
template <typename ArrayT>
|
|
GetPortalConstControlType<typename std::decay<ArrayT>::type> GetPortalConstControl(
|
|
const ArrayT& array)
|
|
{
|
|
return array.GetPortalConstControl();
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
GetPortalConstExecutionType<typename std::decay<ArrayT>::type, Device> GetPortalInput(
|
|
const ArrayT& array,
|
|
Device)
|
|
{
|
|
return array.PrepareForInput(Device{});
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
GetPortalExecutionType<typename std::decay<ArrayT>::type, Device> GetPortalInPlace(ArrayT&& array,
|
|
Device)
|
|
{
|
|
return detail::GetPortalInPlaceImpl(
|
|
IsWritableArrayHandle<ArrayT>{}, std::forward<ArrayT>(array), Device{});
|
|
}
|
|
|
|
template <typename ArrayT, typename Device>
|
|
GetPortalExecutionType<typename std::decay<ArrayT>::type, Device> GetPortalOutput(ArrayT&& array,
|
|
Device)
|
|
{
|
|
return detail::GetPortalOutputImpl(
|
|
IsWritableArrayHandle<ArrayT>{}, std::forward<ArrayT>(array), Device{});
|
|
}
|
|
|
|
// Equivalent to std::true_type if *any* portal in PortalList can be written to.
|
|
// If all are read-only, std::false_type is used instead.
|
|
template <typename PortalList>
|
|
using AnyPortalIsWritable =
|
|
typename brigand::any<PortalList,
|
|
brigand::bind<vtkm::internal::PortalSupportsSets, brigand::_1>>::type;
|
|
|
|
// Set to std::true_type if DecoratorImplT::CreateInverseFunctor can be called
|
|
// with the supplied portals, or std::false_type otherwise.
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
using IsFunctorInvertible =
|
|
typename detail::IsFunctorInvertibleImpl<DecoratorImplT, PortalList>::type;
|
|
|
|
// std::true_type/std::false_type depending on whether the decorator impl has a
|
|
// CreateInversePortal method AND any of the arrays are writable.
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
using CanWriteToFunctor = typename brigand::and_<IsFunctorInvertible<DecoratorImplT, PortalList>,
|
|
AnyPortalIsWritable<PortalList>>::type;
|
|
|
|
// The FunctorType for the provided implementation and portal types.
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
using GetFunctorType = typename detail::GetFunctorTypeImpl<DecoratorImplT, PortalList>::type;
|
|
|
|
// The InverseFunctorType for the provided implementation and portal types.
|
|
// Will detect when inversion is not possible and return a NoOp functor instead.
|
|
template <typename DecoratorImplT, typename PortalList>
|
|
using GetInverseFunctorType =
|
|
typename detail::GetInverseFunctorTypeImpl<CanWriteToFunctor<DecoratorImplT, PortalList>,
|
|
DecoratorImplT,
|
|
PortalList>::type;
|
|
|
|
// Convert a sequence of array handle types to a list of portals:
|
|
|
|
// Some notes on this implementation:
|
|
// - MSVC 2015 ICEs when using brigand::transform to convert a brigand::list
|
|
// of arrayhandles to portals. So instead we pass the ArrayTs.
|
|
// - Just using brigand::list<GetPortalControlType<ArrayTs>...> fails, as
|
|
// apparently that is an improper parameter pack expansion
|
|
// - So we jump through some decltype/declval hoops here to get this to work:
|
|
template <typename... ArrayTs>
|
|
using GetPortalConstControlList =
|
|
brigand::list<decltype((GetPortalConstControl(std::declval<ArrayTs>())))...>;
|
|
|
|
template <typename Device, typename... ArrayTs>
|
|
using GetPortalConstExecutionList =
|
|
brigand::list<decltype((GetPortalInput(std::declval<ArrayTs>(), Device{})))...>;
|
|
|
|
template <typename... ArrayTs>
|
|
using GetPortalControlList =
|
|
brigand::list<decltype((GetPortalControl(std::declval<ArrayTs>())))...>;
|
|
|
|
template <typename Device, typename... ArrayTs>
|
|
using GetPortalExecutionList =
|
|
brigand::list<decltype((GetPortalInPlace(std::declval<ArrayTs>(), Device{})))...>;
|
|
|
|
template <typename DecoratorImplT, typename... ArrayTs>
|
|
struct DecoratorStorageTraits
|
|
{
|
|
using ArrayList = brigand::list<ArrayTs...>;
|
|
|
|
VTKM_STATIC_ASSERT_MSG(sizeof...(ArrayTs) > 0,
|
|
"Must specify at least one source array handle for "
|
|
"ArrayHandleDecorator. Consider using "
|
|
"ArrayHandleImplicit instead.");
|
|
|
|
// Need to check this here, since this traits struct is used in the
|
|
// ArrayHandleDecorator superclass definition before any other
|
|
// static_asserts could be used.
|
|
VTKM_STATIC_ASSERT_MSG(decor::AllAreArrayHandles<ArrayList>::value,
|
|
"Trailing template parameters for "
|
|
"ArrayHandleDecorator must be a list of ArrayHandle "
|
|
"types.");
|
|
|
|
using ArrayTupleType = vtkmstd::tuple<ArrayTs...>;
|
|
|
|
// size_t integral constants that index ArrayTs:
|
|
#ifdef VTKM_USE_BRIGAND_SEQ
|
|
using IndexList = brigand::make_sequence<brigand::size_t<0>, sizeof...(ArrayTs)>;
|
|
#else // VTKM_USE_BRIGAND_SEQ
|
|
using IndexList = tao::seq::make_index_sequence<sizeof...(ArrayTs)>;
|
|
#endif // VTKM_USE_BRIGAND_SEQ
|
|
|
|
// Portal lists:
|
|
// NOTE we have to pass the parameter pack here instead of using ArrayList
|
|
// with brigand::transform, since that's causing MSVC 2015 to ice:
|
|
using PortalControlList = GetPortalControlList<ArrayTs...>;
|
|
using PortalConstControlList = GetPortalConstControlList<ArrayTs...>;
|
|
template <typename Device>
|
|
using PortalExecutionList = GetPortalExecutionList<Device, ArrayTs...>;
|
|
template <typename Device>
|
|
using PortalConstExecutionList = GetPortalConstExecutionList<Device, ArrayTs...>;
|
|
|
|
// Functors:
|
|
using FunctorControlType = GetFunctorType<DecoratorImplT, PortalControlList>;
|
|
using FunctorConstControlType = GetFunctorType<DecoratorImplT, PortalConstControlList>;
|
|
|
|
template <typename Device>
|
|
using FunctorExecutionType = GetFunctorType<DecoratorImplT, PortalExecutionList<Device>>;
|
|
|
|
template <typename Device>
|
|
using FunctorConstExecutionType =
|
|
GetFunctorType<DecoratorImplT, PortalConstExecutionList<Device>>;
|
|
|
|
// Inverse functors:
|
|
using InverseFunctorControlType = GetInverseFunctorType<DecoratorImplT, PortalControlList>;
|
|
|
|
using InverseFunctorConstControlType = NoOpInverseFunctor;
|
|
|
|
template <typename Device>
|
|
using InverseFunctorExecutionType =
|
|
GetInverseFunctorType<DecoratorImplT, PortalExecutionList<Device>>;
|
|
|
|
template <typename Device>
|
|
using InverseFunctorConstExecutionType = NoOpInverseFunctor;
|
|
|
|
// Misc:
|
|
// ValueType is derived from DecoratorImplT::CreateFunctor(...)'s operator().
|
|
using ValueType = decltype(std::declval<FunctorControlType>()(0));
|
|
|
|
// Decorator portals:
|
|
using PortalControlType =
|
|
ArrayPortalDecorator<ValueType, FunctorControlType, InverseFunctorControlType>;
|
|
|
|
using PortalConstControlType =
|
|
ArrayPortalDecorator<ValueType, FunctorConstControlType, InverseFunctorConstControlType>;
|
|
|
|
template <typename Device>
|
|
using PortalExecutionType = ArrayPortalDecorator<ValueType,
|
|
FunctorExecutionType<Device>,
|
|
InverseFunctorExecutionType<Device>>;
|
|
|
|
template <typename Device>
|
|
using PortalConstExecutionType = ArrayPortalDecorator<ValueType,
|
|
FunctorConstExecutionType<Device>,
|
|
InverseFunctorConstExecutionType<Device>>;
|
|
|
|
// helper for constructing portals with the appropriate functors. This is
|
|
// where we decide whether or not to call `CreateInverseFunctor` on the
|
|
// implementation class.
|
|
// Do not use these directly, they are helpers for the MakePortal[...]
|
|
// methods below.
|
|
template <typename DecoratorPortalType, typename... PortalTs>
|
|
VTKM_CONT static
|
|
typename std::enable_if<DecoratorPortalType::ReadOnly::value, DecoratorPortalType>::type
|
|
CreatePortalDecorator(vtkm::Id numVals, const DecoratorImplT& impl, PortalTs&&... portals)
|
|
{ // Portal is read only:
|
|
return { impl.CreateFunctor(std::forward<PortalTs>(portals)...),
|
|
typename DecoratorPortalType::InverseFunctorType{},
|
|
numVals };
|
|
}
|
|
|
|
template <typename DecoratorPortalType, typename... PortalTs>
|
|
VTKM_CONT static
|
|
typename std::enable_if<!DecoratorPortalType::ReadOnly::value, DecoratorPortalType>::type
|
|
CreatePortalDecorator(vtkm::Id numVals, const DecoratorImplT& impl, PortalTs... portals)
|
|
{ // Portal is read/write:
|
|
return { impl.CreateFunctor(portals...), impl.CreateInverseFunctor(portals...), numVals };
|
|
}
|
|
|
|
#ifdef VTKM_USE_BRIGAND_SEQ
|
|
// Portal construction methods. These actually create portals.
|
|
template <template <typename...> class List, typename... Indices>
|
|
VTKM_CONT static PortalControlType MakePortalControl(const DecoratorImplT& impl,
|
|
ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<Indices...>)
|
|
{
|
|
return CreatePortalDecorator<PortalControlType>(
|
|
numValues,
|
|
impl,
|
|
// More MSVC ICE avoidance while expanding the Indices parameter pack,
|
|
// which is a list of std::integral_constant<size_t, ...>:
|
|
//
|
|
// Indices::value : Works everywhere but MSVC2017, which crashes on it.
|
|
// Indices{} : Works on MSVC2017, but won't compile on MSVC2015.
|
|
// Indices{}.value : Works on both MSVC2015 and MSVC2017.
|
|
//
|
|
// Don't touch the following line unless you really, really have to.
|
|
GetPortalControl(vtkmstd::get<Indices{}.value>(arrays))...);
|
|
}
|
|
|
|
template <template <typename...> class List, typename... Indices>
|
|
VTKM_CONT static PortalConstControlType MakePortalConstControl(const DecoratorImplT& impl,
|
|
const ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<Indices...>)
|
|
{
|
|
return CreatePortalDecorator<PortalConstControlType>(
|
|
numValues,
|
|
impl,
|
|
// Don't touch the following line unless you really, really have to. See
|
|
// note in MakePortalControl.
|
|
GetPortalConstControl(vtkmstd::get<Indices{}.value>(arrays))...);
|
|
}
|
|
|
|
template <template <typename...> class List, typename... Indices, typename Device>
|
|
VTKM_CONT static PortalConstExecutionType<Device> MakePortalInput(const DecoratorImplT& impl,
|
|
const ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<Indices...>,
|
|
Device dev)
|
|
{
|
|
return CreatePortalDecorator<PortalConstExecutionType<Device>>(
|
|
numValues,
|
|
impl,
|
|
// Don't touch the following line unless you really, really have to. See
|
|
// note in MakePortalControl.
|
|
GetPortalInput(vtkmstd::get<Indices{}.value>(arrays), dev)...);
|
|
}
|
|
|
|
template <template <typename...> class List, typename... Indices, typename Device>
|
|
VTKM_CONT static PortalExecutionType<Device> MakePortalInPlace(const DecoratorImplT& impl,
|
|
ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<Indices...>,
|
|
Device dev)
|
|
{
|
|
return CreatePortalDecorator<PortalExecutionType<Device>>(
|
|
numValues,
|
|
impl,
|
|
// Don't touch the following line unless you really, really have to. See
|
|
// note in MakePortalControl.
|
|
GetPortalInPlace(vtkmstd::get<Indices{}.value>(arrays), dev)...);
|
|
}
|
|
|
|
template <template <typename...> class List, typename... Indices, typename Device>
|
|
VTKM_CONT static PortalExecutionType<Device> MakePortalOutput(const DecoratorImplT& impl,
|
|
ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<Indices...>,
|
|
Device dev)
|
|
{
|
|
return CreatePortalDecorator<PortalExecutionType<Device>>(
|
|
numValues,
|
|
impl,
|
|
// Don't touch the following line unless you really, really have to. See
|
|
// note in MakePortalControl.
|
|
GetPortalOutput(vtkmstd::get<Indices{}.value>(arrays), dev)...);
|
|
}
|
|
|
|
#else // VTKM_USE_BRIGAND_SEQ
|
|
// Portal construction methods. These actually create portals.
|
|
template <template <typename, std::size_t...> class List, std::size_t... Indices>
|
|
VTKM_CONT static PortalControlType MakePortalControl(const DecoratorImplT& impl,
|
|
ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<std::size_t, Indices...>)
|
|
{
|
|
return CreatePortalDecorator<PortalControlType>(
|
|
numValues, impl, GetPortalControl(vtkmstd::get<Indices>(arrays))...);
|
|
}
|
|
|
|
template <template <typename, std::size_t...> class List, std::size_t... Indices>
|
|
VTKM_CONT static PortalConstControlType MakePortalConstControl(const DecoratorImplT& impl,
|
|
const ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<std::size_t, Indices...>)
|
|
{
|
|
return CreatePortalDecorator<PortalConstControlType>(
|
|
numValues, impl, GetPortalConstControl(vtkmstd::get<Indices>(arrays))...);
|
|
}
|
|
|
|
template <template <typename, std::size_t...> class List, std::size_t... Indices, typename Device>
|
|
VTKM_CONT static PortalConstExecutionType<Device> MakePortalInput(const DecoratorImplT& impl,
|
|
const ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<std::size_t, Indices...>,
|
|
Device dev)
|
|
{
|
|
return CreatePortalDecorator<PortalConstExecutionType<Device>>(
|
|
numValues, impl, GetPortalInput(vtkmstd::get<Indices>(arrays), dev)...);
|
|
}
|
|
|
|
template <template <typename, std::size_t...> class List, std::size_t... Indices, typename Device>
|
|
VTKM_CONT static PortalExecutionType<Device> MakePortalInPlace(const DecoratorImplT& impl,
|
|
ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<std::size_t, Indices...>,
|
|
Device dev)
|
|
{
|
|
return CreatePortalDecorator<PortalExecutionType<Device>>(
|
|
numValues, impl, GetPortalInPlace(vtkmstd::get<Indices>(arrays), dev)...);
|
|
}
|
|
|
|
template <template <typename, std::size_t...> class List, std::size_t... Indices, typename Device>
|
|
VTKM_CONT static PortalExecutionType<Device> MakePortalOutput(const DecoratorImplT& impl,
|
|
ArrayTupleType& arrays,
|
|
vtkm::Id numValues,
|
|
List<std::size_t, Indices...>,
|
|
Device dev)
|
|
{
|
|
return CreatePortalDecorator<PortalExecutionType<Device>>(
|
|
numValues, impl, GetPortalOutput(vtkmstd::get<Indices>(arrays), dev)...);
|
|
}
|
|
#endif // VTKM_USE_BRIGAND_SEQ
|
|
};
|
|
|
|
} // end namespace decor
|
|
|
|
template <typename DecoratorImplT, typename... ArrayTs>
|
|
struct VTKM_ALWAYS_EXPORT StorageTagDecorator
|
|
{
|
|
};
|
|
|
|
template <typename DecoratorImplT, typename... ArrayTs>
|
|
class Storage<typename decor::DecoratorStorageTraits<DecoratorImplT, ArrayTs...>::ValueType,
|
|
StorageTagDecorator<DecoratorImplT, ArrayTs...>>
|
|
{
|
|
using Traits = decor::DecoratorStorageTraits<DecoratorImplT, ArrayTs...>;
|
|
using IndexList = typename Traits::IndexList;
|
|
|
|
public:
|
|
using ArrayTupleType = typename Traits::ArrayTupleType;
|
|
using ValueType = typename Traits::ValueType;
|
|
using PortalType = typename Traits::PortalControlType;
|
|
using PortalConstType = typename Traits::PortalConstControlType;
|
|
|
|
VTKM_CONT
|
|
Storage()
|
|
: Valid{ false }
|
|
{
|
|
}
|
|
|
|
VTKM_CONT
|
|
Storage(const DecoratorImplT& impl, const ArrayTupleType& arrayTuple, vtkm::Id numValues)
|
|
: Implementation(impl)
|
|
, ArrayTuple{ arrayTuple }
|
|
, NumberOfValues(numValues)
|
|
, Valid{ true }
|
|
{
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalType GetPortal()
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return Traits::MakePortalControl(
|
|
this->Implementation, this->ArrayTuple, this->NumberOfValues, IndexList{});
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalConstType GetPortalConst() const
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return Traits::MakePortalConstControl(
|
|
this->Implementation, this->ArrayTuple, this->NumberOfValues, IndexList{});
|
|
}
|
|
|
|
VTKM_CONT
|
|
vtkm::Id GetNumberOfValues() const
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return this->NumberOfValues;
|
|
}
|
|
|
|
VTKM_CONT
|
|
void Allocate(vtkm::Id)
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
// No-op. I suppose eventually we could pass numValues down to the
|
|
// implementation class and let it do something intelligent.
|
|
}
|
|
|
|
VTKM_CONT
|
|
void Shrink(vtkm::Id)
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
// No-op. Again, could eventually be passed down to the implementation.
|
|
}
|
|
|
|
VTKM_CONT
|
|
void ReleaseResources()
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
// No-op. Again, could eventually be passed down to the implementation.
|
|
}
|
|
|
|
VTKM_CONT
|
|
const ArrayTupleType& GetArrayTuple() const
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return this->ArrayTuple;
|
|
}
|
|
|
|
VTKM_CONT
|
|
ArrayTupleType& GetArrayTuple()
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return this->ArrayTuple;
|
|
}
|
|
|
|
VTKM_CONT
|
|
const DecoratorImplT& GetImplementation() const
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return this->Implementation;
|
|
}
|
|
|
|
VTKM_CONT
|
|
DecoratorImplT& GetImplementation()
|
|
{
|
|
VTKM_ASSERT(this->Valid);
|
|
return this->Implementation;
|
|
}
|
|
|
|
private:
|
|
DecoratorImplT Implementation;
|
|
ArrayTupleType ArrayTuple;
|
|
vtkm::Id NumberOfValues;
|
|
|
|
bool Valid;
|
|
};
|
|
|
|
template <typename DecoratorImplT, typename... ArrayTs>
|
|
struct DecoratorHandleTraits
|
|
{
|
|
using StorageTraits = decor::DecoratorStorageTraits<DecoratorImplT, ArrayTs...>;
|
|
using ValueType = typename StorageTraits::ValueType;
|
|
using StorageTag = StorageTagDecorator<DecoratorImplT, ArrayTs...>;
|
|
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
|
|
using Superclass = vtkm::cont::ArrayHandle<ValueType, StorageTag>;
|
|
};
|
|
|
|
template <typename DecoratorImplT, typename... ArrayTs, typename Device>
|
|
class ArrayTransfer<typename decor::DecoratorStorageTraits<DecoratorImplT, ArrayTs...>::ValueType,
|
|
StorageTagDecorator<DecoratorImplT, ArrayTs...>,
|
|
Device>
|
|
{
|
|
VTKM_IS_DEVICE_ADAPTER_TAG(Device);
|
|
|
|
using HandleTraits = DecoratorHandleTraits<DecoratorImplT, ArrayTs...>;
|
|
using Traits = typename HandleTraits::StorageTraits;
|
|
using IndexList = typename Traits::IndexList;
|
|
using StorageType = typename HandleTraits::StorageType;
|
|
|
|
public:
|
|
using ValueType = typename Traits::ValueType;
|
|
|
|
using PortalControl = typename Traits::PortalControlType;
|
|
using PortalConstControl = typename Traits::PortalConstControlType;
|
|
|
|
using PortalExecution = typename Traits::template PortalExecutionType<Device>;
|
|
using PortalConstExecution = typename Traits::template PortalConstExecutionType<Device>;
|
|
|
|
VTKM_CONT
|
|
ArrayTransfer(StorageType* storage)
|
|
: Storage(storage)
|
|
{
|
|
}
|
|
|
|
VTKM_CONT
|
|
vtkm::Id GetNumberOfValues() const { return this->Storage->GetNumberOfValues(); }
|
|
|
|
VTKM_CONT
|
|
PortalConstExecution PrepareForInput(bool vtkmNotUsed(updateData)) const
|
|
{
|
|
return Traits::MakePortalInput(this->Storage->GetImplementation(),
|
|
this->Storage->GetArrayTuple(),
|
|
this->Storage->GetNumberOfValues(),
|
|
IndexList{},
|
|
Device{});
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalExecution PrepareForInPlace(bool vtkmNotUsed(updateData))
|
|
{
|
|
return Traits::MakePortalInPlace(this->Storage->GetImplementation(),
|
|
this->Storage->GetArrayTuple(),
|
|
this->Storage->GetNumberOfValues(),
|
|
IndexList{},
|
|
Device{});
|
|
}
|
|
|
|
VTKM_CONT
|
|
PortalExecution PrepareForOutput(vtkm::Id)
|
|
{
|
|
return Traits::MakePortalOutput(this->Storage->GetImplementation(),
|
|
this->Storage->GetArrayTuple(),
|
|
this->Storage->GetNumberOfValues(),
|
|
IndexList{},
|
|
Device{});
|
|
}
|
|
|
|
VTKM_CONT
|
|
void RetrieveOutputData(StorageType* vtkmNotUsed(storage)) const
|
|
{
|
|
// Implementation of this method should be unnecessary. The internal
|
|
// array handles should automatically retrieve the output data as
|
|
// necessary.
|
|
}
|
|
|
|
VTKM_CONT
|
|
void Shrink(vtkm::Id)
|
|
{
|
|
// no-op
|
|
}
|
|
|
|
|
|
VTKM_CONT
|
|
void ReleaseResources()
|
|
{
|
|
// no-op
|
|
}
|
|
|
|
private:
|
|
StorageType* Storage;
|
|
};
|
|
|
|
} // namespace internal
|
|
|
|
/// \brief A fancy ArrayHandle that can be used to modify the results from one
|
|
/// or more source ArrayHandle.
|
|
///
|
|
/// ArrayHandleDecorator is given a `DecoratorImplT` class and a list of one or
|
|
/// more source ArrayHandles. There are no restrictions on the size or type of
|
|
/// the source ArrayHandles.
|
|
///
|
|
/// The decorator implementation class is described below:
|
|
///
|
|
/// ```
|
|
/// struct ExampleDecoratorImplementation
|
|
/// {
|
|
///
|
|
/// // Takes one portal for each source array handle (only two shown).
|
|
/// // Returns a functor that defines:
|
|
/// //
|
|
/// // ValueType operator()(vtkm::Id id) const;
|
|
/// //
|
|
/// // which takes an index and returns a value which should be produced by
|
|
/// // the source arrays somehow. This ValueType will be the ValueType of the
|
|
/// // ArrayHandleDecorator.
|
|
/// //
|
|
/// // Both SomeFunctor::operator() and CreateFunctor must be const.
|
|
/// //
|
|
/// template <typename Portal1Type, typename Portal2Type>
|
|
/// SomeFunctor CreateFunctor(Portal1Type portal1, Portal2Type portal2) const;
|
|
///
|
|
/// // Takes one portal for each source array handle (only two shown).
|
|
/// // Returns a functor that defines:
|
|
/// //
|
|
/// // void operator()(vtkm::Id id, ValueType val) const;
|
|
/// //
|
|
/// // which takes an index and a value, which should be used to modify one
|
|
/// // or more of the source arrays.
|
|
/// //
|
|
/// // CreateInverseFunctor is optional; if not provided, the
|
|
/// // ArrayHandleDecorator will be read-only. In addition, if all of the
|
|
/// // source ArrayHandles are read-only, the inverse functor will not be used
|
|
/// // and the ArrayHandleDecorator will be read only.
|
|
/// //
|
|
/// // Both SomeInverseFunctor::operator() and CreateInverseFunctor must be
|
|
/// // const.
|
|
/// //
|
|
/// template <typename Portal1Type, typename Portal2Type>
|
|
/// SomeInverseFunctor CreateInverseFunctor(Portal1Type portal1,
|
|
/// Portal2Type portal2) const;
|
|
///
|
|
/// };
|
|
/// ```
|
|
///
|
|
/// There are several example DecoratorImpl classes provided in the
|
|
/// UnitTestArrayHandleDecorator test file.
|
|
///
|
|
template <typename DecoratorImplT, typename... ArrayTs>
|
|
class ArrayHandleDecorator
|
|
: public internal::DecoratorHandleTraits<typename std::decay<DecoratorImplT>::type,
|
|
typename std::decay<ArrayTs>::type...>::Superclass
|
|
{
|
|
private:
|
|
using Traits = internal::DecoratorHandleTraits<typename std::decay<DecoratorImplT>::type,
|
|
typename std::decay<ArrayTs>::type...>;
|
|
using StorageType = typename Traits::StorageType;
|
|
|
|
public:
|
|
VTKM_ARRAY_HANDLE_SUBCLASS(ArrayHandleDecorator,
|
|
(ArrayHandleDecorator<typename std::decay<DecoratorImplT>::type,
|
|
typename std::decay<ArrayTs>::type...>),
|
|
(typename Traits::Superclass));
|
|
|
|
VTKM_CONT
|
|
ArrayHandleDecorator(vtkm::Id numValues,
|
|
const typename std::decay<DecoratorImplT>::type& impl,
|
|
const typename std::decay<ArrayTs>::type&... arrays)
|
|
: Superclass{ StorageType{ impl, vtkmstd::make_tuple(arrays...), numValues } }
|
|
{
|
|
}
|
|
};
|
|
|
|
/// Create an ArrayHandleDecorator with the specified number of values that
|
|
/// uses the provided DecoratorImplT and source ArrayHandles.
|
|
///
|
|
template <typename DecoratorImplT, typename... ArrayTs>
|
|
VTKM_CONT ArrayHandleDecorator<typename std::decay<DecoratorImplT>::type,
|
|
typename std::decay<ArrayTs>::type...>
|
|
make_ArrayHandleDecorator(vtkm::Id numValues, DecoratorImplT&& f, ArrayTs&&... arrays)
|
|
{
|
|
using AHList = brigand::list<typename std::decay<ArrayTs>::type...>;
|
|
VTKM_STATIC_ASSERT_MSG(sizeof...(ArrayTs) > 0,
|
|
"Must specify at least one source array handle for "
|
|
"ArrayHandleDecorator. Consider using "
|
|
"ArrayHandleImplicit instead.");
|
|
VTKM_STATIC_ASSERT_MSG(internal::decor::AllAreArrayHandles<AHList>::value,
|
|
"Trailing template parameters for "
|
|
"ArrayHandleDecorator must be a list of ArrayHandle "
|
|
"types.");
|
|
|
|
return { numValues, std::forward<DecoratorImplT>(f), std::forward<ArrayTs>(arrays)... };
|
|
}
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#undef VTKM_USE_BRIGAND_SEQ
|
|
|
|
#endif //vtk_m_ArrayHandleDecorator_h
|