mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 21:33:55 +00:00
5ef4e7eeee
What was previously declared as `ArrayHandleNewStyle` is now just the implementation of `ArrayHandle`. The old implementation of `ArrayHandle` has been moved to `ArrayHandleDeprecated`, and `ArrayHandle`s still using this implementation must declare `VTKM_ARRAY_HANDLE_DEPRECATED` to use it.
718 lines
27 KiB
C++
718 lines
27 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/ErrorBadType.h>
|
|
#include <vtkm/cont/Storage.h>
|
|
|
|
#include <vtkm/StaticAssert.h>
|
|
#include <vtkm/Tuple.h>
|
|
#include <vtkm/VecTraits.h>
|
|
|
|
#include <vtkm/internal/ArrayPortalHelpers.h>
|
|
#include <vtkm/internal/brigand.hpp>
|
|
|
|
#include <vtkmstd/integer_sequence.h>
|
|
|
|
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
namespace vtkm
|
|
{
|
|
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 vtkm::internal
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
namespace internal
|
|
{
|
|
|
|
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:
|
|
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));
|
|
};
|
|
|
|
// Tests whether DecoratorImplT has an AllocateSourceArrays(size, Arrays...) method.
|
|
template <typename DecoratorImplT, typename ArrayList>
|
|
struct IsDecoratorAllocatableImpl;
|
|
|
|
template <typename DecoratorImplT, template <typename...> class List, typename... ArrayTs>
|
|
struct IsDecoratorAllocatableImpl<DecoratorImplT, List<ArrayTs...>>
|
|
{
|
|
private:
|
|
template <
|
|
typename T,
|
|
typename U = decltype(std::declval<T>().AllocateSourceArrays(0,
|
|
vtkm::CopyFlag::Off,
|
|
std::declval<vtkm::cont::Token&>(),
|
|
std::declval<ArrayTs&>()...))>
|
|
static std::true_type Exists(int);
|
|
template <typename T>
|
|
static std::false_type Exists(...);
|
|
|
|
public:
|
|
using type = decltype(Exists<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 = vtkm::internal::decor::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::WritePortalType GetWritePortalImpl(
|
|
std::true_type,
|
|
ArrayT&& array,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return ArrayT::StorageType::CreateWritePortal(array.GetBuffers(), device, token);
|
|
}
|
|
|
|
template <typename ArrayT>
|
|
typename std::decay<ArrayT>::type::ReadPortalType GetWritePortalImpl(
|
|
std::false_type,
|
|
ArrayT&& array,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return ArrayT::StorageType::CreateReadPortal(array.GetBuffers(), device, token);
|
|
}
|
|
|
|
} // 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::WritePortalType,
|
|
typename PortalConst = typename std::decay<ArrayT>::type::ReadPortalType>
|
|
using GetWritePortalType =
|
|
typename brigand::if_<vtkm::internal::PortalSupportsSets<Portal>, Portal, PortalConst>::type;
|
|
|
|
template <typename ArrayT>
|
|
using GetReadPortalType = typename std::decay<ArrayT>::type::ReadPortalType;
|
|
|
|
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>
|
|
GetWritePortalType<typename std::decay<ArrayT>::type>
|
|
WritePortal(ArrayT&& array, vtkm::cont::DeviceAdapterId device, vtkm::cont::Token& token)
|
|
{
|
|
return detail::GetWritePortalImpl(
|
|
IsWritableArrayHandle<ArrayT>{}, std::forward<ArrayT>(array), device, token);
|
|
}
|
|
|
|
template <typename ArrayT>
|
|
GetReadPortalType<typename std::decay<ArrayT>::type> ReadPortal(const ArrayT& array,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return ArrayT::StorageType::CreateReadPortal(array.GetBuffers(), device, token);
|
|
}
|
|
|
|
// 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;
|
|
|
|
// Set to std::true_type if DecoratorImplT::AllocateSourceArrays can be called
|
|
// with the supplied arrays, or std::false_type otherwise.
|
|
template <typename DecoratorImplT, typename ArrayList>
|
|
using IsDecoratorAllocatable =
|
|
typename detail::IsDecoratorAllocatableImpl<DecoratorImplT, ArrayList>::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<GetWritePortalType<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 GetReadPortalList =
|
|
brigand::list<decltype((ReadPortal(std::declval<ArrayTs&>(),
|
|
std::declval<vtkm::cont::DeviceAdapterId>(),
|
|
std::declval<vtkm::cont::Token&>())))...>;
|
|
|
|
template <typename... ArrayTs>
|
|
using GetWritePortalList =
|
|
brigand::list<decltype((WritePortal(std::declval<ArrayTs&>(),
|
|
std::declval<vtkm::cont::DeviceAdapterId>(),
|
|
std::declval<vtkm::cont::Token&>())))...>;
|
|
|
|
template <vtkm::IdComponent I, typename ArrayTupleType>
|
|
struct BufferIndexImpl
|
|
{
|
|
static constexpr vtkm::IdComponent Value()
|
|
{
|
|
return BufferIndexImpl<I - 1, ArrayTupleType>::Value() +
|
|
vtkm::TupleElement<I - 1, ArrayTupleType>::GetNumberOfBuffers();
|
|
}
|
|
};
|
|
template <typename ArrayTupleType>
|
|
struct BufferIndexImpl<0, ArrayTupleType>
|
|
{
|
|
static constexpr vtkm::IdComponent Value()
|
|
{
|
|
// One buffer reserved for metadata.
|
|
return 1;
|
|
}
|
|
};
|
|
|
|
template <typename DecoratorImplT>
|
|
struct DecoratorMetaData
|
|
{
|
|
DecoratorImplT Implementation;
|
|
vtkm::Id NumberOfValues = 0;
|
|
|
|
DecoratorMetaData(const DecoratorImplT& implementation, vtkm::Id numValues)
|
|
: Implementation(implementation)
|
|
, NumberOfValues(numValues)
|
|
{
|
|
}
|
|
|
|
DecoratorMetaData() = default;
|
|
};
|
|
|
|
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 = vtkm::Tuple<ArrayTs...>;
|
|
|
|
// size_t integral constants that index ArrayTs:
|
|
using IndexList = vtkmstd::make_index_sequence<sizeof...(ArrayTs)>;
|
|
|
|
// Returns the index into the buffers array for the array at the given index.
|
|
template <vtkm::IdComponent I>
|
|
static constexpr vtkm::IdComponent BufferIndex()
|
|
{
|
|
return BufferIndexImpl<I, ArrayTupleType>::Value();
|
|
}
|
|
|
|
// Converts a buffers array to the ArrayHandle at the given index.
|
|
template <vtkm::IdComponent I>
|
|
static vtkm::TupleElement<I, ArrayTupleType> BuffersToArray(
|
|
const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return vtkm::TupleElement<I, ArrayTupleType>(buffers + BufferIndex<I>());
|
|
}
|
|
|
|
using MetaData = DecoratorMetaData<DecoratorImplT>;
|
|
|
|
static MetaData& GetMetaData(const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return buffers[0].GetMetaData<MetaData>();
|
|
}
|
|
|
|
// true_type/false_type depending on whether the decorator supports Allocate:
|
|
using IsAllocatable = IsDecoratorAllocatable<DecoratorImplT, ArrayList>;
|
|
|
|
// 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 WritePortalList = GetWritePortalList<ArrayTs...>;
|
|
using ReadPortalList = GetReadPortalList<ArrayTs...>;
|
|
|
|
// Functors:
|
|
using WriteFunctorType = GetFunctorType<DecoratorImplT, WritePortalList>;
|
|
using ReadFunctorType = GetFunctorType<DecoratorImplT, ReadPortalList>;
|
|
|
|
// Inverse functors:
|
|
using InverseWriteFunctorType = GetInverseFunctorType<DecoratorImplT, WritePortalList>;
|
|
|
|
using InverseReadFunctorType = vtkm::internal::decor::NoOpInverseFunctor;
|
|
|
|
// Misc:
|
|
// ValueType is derived from DecoratorImplT::CreateFunctor(...)'s operator().
|
|
using ValueType = decltype(std::declval<WriteFunctorType>()(0));
|
|
|
|
// Decorator portals:
|
|
using WritePortalType =
|
|
vtkm::internal::ArrayPortalDecorator<ValueType, WriteFunctorType, InverseWriteFunctorType>;
|
|
|
|
using ReadPortalType =
|
|
vtkm::internal::ArrayPortalDecorator<ValueType, ReadFunctorType, InverseReadFunctorType>;
|
|
|
|
// 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 };
|
|
}
|
|
|
|
// Static dispatch for calling AllocateSourceArrays on supported implementations:
|
|
VTKM_CONT [[noreturn]] static void CallAllocate(std::false_type,
|
|
vtkm::Id,
|
|
vtkm::cont::internal::Buffer*,
|
|
vtkm::CopyFlag,
|
|
vtkm::cont::Token&,
|
|
ArrayTs...)
|
|
{
|
|
throw vtkm::cont::ErrorBadType("Allocate not supported by this ArrayHandleDecorator.");
|
|
}
|
|
|
|
VTKM_CONT static void CallAllocate(std::true_type,
|
|
vtkm::Id newSize,
|
|
vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::CopyFlag preserve,
|
|
vtkm::cont::Token& token,
|
|
ArrayTs... arrays)
|
|
{
|
|
MetaData& metadata = GetMetaData(buffers);
|
|
metadata.Implementation.AllocateSourceArrays(newSize, preserve, token, arrays...);
|
|
metadata.NumberOfValues = newSize;
|
|
}
|
|
|
|
|
|
// Portal construction methods. These actually create portals.
|
|
template <std::size_t... Indices>
|
|
VTKM_CONT static WritePortalType CreateWritePortal(const vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::Id numValues,
|
|
vtkmstd::index_sequence<Indices...>,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return CreatePortalDecorator<WritePortalType>(
|
|
numValues,
|
|
GetMetaData(buffers).Implementation,
|
|
WritePortal(BuffersToArray<Indices>(buffers), device, token)...);
|
|
}
|
|
|
|
template <std::size_t... Indices>
|
|
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::Id numValues,
|
|
vtkmstd::index_sequence<Indices...>,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return CreatePortalDecorator<ReadPortalType>(
|
|
numValues,
|
|
GetMetaData(buffers).Implementation,
|
|
ReadPortal(BuffersToArray<Indices>(buffers), device, token)...);
|
|
}
|
|
|
|
template <std::size_t... Indices>
|
|
VTKM_CONT static void AllocateSourceArrays(vtkm::Id numValues,
|
|
vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::CopyFlag preserve,
|
|
vtkm::cont::Token& token,
|
|
vtkmstd::index_sequence<Indices...>)
|
|
{
|
|
CallAllocate(
|
|
IsAllocatable{}, numValues, buffers, preserve, token, BuffersToArray<Indices>(buffers)...);
|
|
}
|
|
};
|
|
|
|
} // 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;
|
|
using MetaData = typename Traits::MetaData;
|
|
|
|
public:
|
|
using ReadPortalType = typename Traits::ReadPortalType;
|
|
using WritePortalType = typename Traits::WritePortalType;
|
|
|
|
VTKM_CONT constexpr static vtkm::IdComponent GetNumberOfBuffers()
|
|
{
|
|
return Traits::template BufferIndex<static_cast<vtkm::IdComponent>(sizeof...(ArrayTs))>();
|
|
}
|
|
|
|
VTKM_CONT static vtkm::Id GetNumberOfValues(const vtkm::cont::internal::Buffer* buffers)
|
|
{
|
|
return Traits::GetMetaData(buffers).NumberOfValues;
|
|
}
|
|
|
|
VTKM_CONT static void ResizeBuffers(vtkm::Id numValues,
|
|
vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::CopyFlag preserve,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
if (numValues != GetNumberOfValues(buffers))
|
|
{
|
|
Traits::AllocateSourceArrays(numValues, buffers, preserve, token, IndexList{});
|
|
}
|
|
else
|
|
{
|
|
// Do nothing. We have this condition to allow allocating the same size when the
|
|
// array cannot be resized.
|
|
}
|
|
}
|
|
|
|
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return Traits::CreateReadPortal(
|
|
buffers, GetNumberOfValues(buffers), IndexList{}, device, token);
|
|
}
|
|
|
|
VTKM_CONT static WritePortalType CreateWritePortal(vtkm::cont::internal::Buffer* buffers,
|
|
vtkm::cont::DeviceAdapterId device,
|
|
vtkm::cont::Token& token)
|
|
{
|
|
return Traits::CreateWritePortal(
|
|
buffers, GetNumberOfValues(buffers), IndexList{}, device, token);
|
|
}
|
|
|
|
VTKM_CONT static std::vector<vtkm::cont::internal::Buffer>
|
|
CreateBuffers(const DecoratorImplT& implementation, vtkm::Id numValues, const ArrayTs&... arrays)
|
|
{
|
|
return vtkm::cont::internal::CreateBuffers(MetaData(implementation, numValues), arrays...);
|
|
}
|
|
};
|
|
|
|
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>;
|
|
};
|
|
|
|
} // 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:
|
|
/// //
|
|
/// // VTKM_EXEC_CONT 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>
|
|
/// VTKM_CONT
|
|
/// SomeFunctor CreateFunctor(Portal1Type portal1, Portal2Type portal2) const;
|
|
///
|
|
/// // Takes one portal for each source array handle (only two shown).
|
|
/// // Returns a functor that defines:
|
|
/// //
|
|
/// // VTKM_EXEC_CONT 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>
|
|
/// VTKM_CONT
|
|
/// SomeInverseFunctor CreateInverseFunctor(Portal1Type portal1,
|
|
/// Portal2Type portal2) const;
|
|
///
|
|
/// // Given a set of ArrayHandles and a size, implement what should happen
|
|
/// // to the source ArrayHandles when Allocate() is called on the decorator
|
|
/// // handle.
|
|
/// //
|
|
/// // AllocateSourceArrays is optional; if not provided, the
|
|
/// // ArrayHandleDecorator will throw if its Allocate method is called. If
|
|
/// // an implementation is present and doesn't throw, the
|
|
/// // ArrayHandleDecorator's internal state is updated to show `size` as the
|
|
/// // number of values.
|
|
/// template <typename Array1Type, typename Array2Type>
|
|
/// VTKM_CONT
|
|
/// void AllocateSourceArrays(vtkm::Id size,
|
|
/// vtkm::CopyFlag preserve,
|
|
/// vtkm::cont::Token& token,
|
|
/// Array1Type array1,
|
|
/// Array2Type array2) 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::CreateBuffers(impl, numValues, arrays...) }
|
|
{
|
|
}
|
|
};
|
|
|
|
/// 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
|
|
|
|
#ifdef VTKM_USE_TAO_SEQ
|
|
#undef VTKM_USE_TAO_SEQ
|
|
#endif
|
|
|
|
#endif //vtk_m_ArrayHandleDecorator_h
|