Merge topic 'arrayhandlecompositevec-use-buffer'

fb130d42d Remove test for ArrayHandleCompositeVector with bad lengths
7cbf40d5b Back out of using a composite of transform arrays
7ff1a690d Support ArrayHandleCompositeVector with 1 component
5391e353a Convert ArrayHandleExtractComponent to new buffer-style array
22fac15b3 Convert ArrayHandleCompositeVector to new buffer-style array

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Robert Maynard <robert.maynard@kitware.com>
Merge-request: !2330
This commit is contained in:
Kenneth Moreland 2020-11-28 18:37:21 +00:00 committed by Kitware Robot
commit a77a1f7f48
5 changed files with 295 additions and 515 deletions

@ -25,41 +25,16 @@
namespace vtkm
{
namespace cont
{
namespace internal
{
namespace compvec
{
// AllAreArrayHandles: ---------------------------------------------------------
// Ensures that all types in ArrayHandlesT... are subclasses of ArrayHandleBase
template <typename... ArrayHandlesT>
struct AllAreArrayHandlesImpl;
template <typename Head, typename... Tail>
struct AllAreArrayHandlesImpl<Head, Tail...>
{
private:
using Next = AllAreArrayHandlesImpl<Tail...>;
constexpr static bool HeadValid = std::is_base_of<ArrayHandleBase, Head>::value;
public:
constexpr static bool Value = HeadValid && Next::Value;
};
template <typename Head>
struct AllAreArrayHandlesImpl<Head>
{
constexpr static bool Value = std::is_base_of<ArrayHandleBase, Head>::value;
};
template <typename... ArrayHandleTs>
struct AllAreArrayHandles
{
constexpr static bool Value = AllAreArrayHandlesImpl<ArrayHandleTs...>::Value;
};
template <typename... PortalList>
using AllPortalsAreWritable =
typename brigand::all<brigand::list<PortalList...>,
brigand::bind<vtkm::internal::PortalSupportsSets, brigand::_1>>::type;
// GetValueType: ---------------------------------------------------------------
// Determines the output `ValueType` of the set of `ArrayHandle` objects. For example, if the input
@ -93,169 +68,6 @@ struct GetValueType<ArrayType>
using ValueType = typename ArrayType::ValueType;
};
// -----------------------------------------------------------------------------
// Functors to access Storage methods. This is used with vtkm::Tuple's
// ForEach and Transform methods.
struct WritePortal
{
template <typename ArrayHandle>
typename ArrayHandle::WritePortalType operator()(const ArrayHandle& array) const
{
return array.WritePortal();
}
};
struct ReadPortal
{
template <typename ArrayHandle>
typename ArrayHandle::ReadPortalType operator()(const ArrayHandle& array) const
{
return array.ReadPortal();
}
};
struct Allocate
{
vtkm::Id NumValues;
VTKM_CONT Allocate(vtkm::Id numValues)
: NumValues(numValues)
{
}
template <typename Array>
VTKM_CONT void operator()(Array& array)
{
array.Allocate(this->NumValues);
}
};
struct Shrink
{
vtkm::Id NumValues;
VTKM_CONT Shrink(vtkm::Id numValues)
: NumValues(numValues)
{
}
template <typename Array>
VTKM_CONT void operator()(Array& array)
{
array.Shrink(this->NumValues);
}
};
struct ReleaseResources
{
template <typename Array>
VTKM_CONT void operator()(Array& array)
{
array.ReleaseResources();
}
};
// -----------------------------------------------------------------------------
// Functors to access ArrayTransfer methods. This is used with vtkm::Tuple's
// ForEach and Transform methods.
template <typename Device>
struct PrepareForInput
{
vtkm::cont::Token& Token;
VTKM_CONT PrepareForInput(vtkm::cont::Token& token)
: Token(token)
{
}
template <typename Array>
VTKM_CONT typename Array::template ExecutionTypes<Device>::PortalConst operator()(
const Array& array)
{
return array.PrepareForInput(Device{}, this->Token);
}
};
template <typename Device>
struct PrepareForInPlace
{
vtkm::cont::Token& Token;
VTKM_CONT PrepareForInPlace(vtkm::cont::Token& token)
: Token(token)
{
}
template <typename Array>
VTKM_CONT typename Array::template ExecutionTypes<Device>::Portal operator()(Array& array)
{
return array.PrepareForInPlace(Device{}, this->Token);
}
};
template <typename Device>
struct PrepareForOutput
{
vtkm::Id NumValues;
vtkm::cont::Token& Token;
VTKM_CONT PrepareForOutput(vtkm::Id numValues, vtkm::cont::Token& token)
: NumValues(numValues)
, Token(token)
{
}
template <typename Array>
VTKM_CONT typename Array::template ExecutionTypes<Device>::Portal operator()(Array& array)
{
return array.PrepareForOutput(this->NumValues, Device{}, this->Token);
}
};
struct ReleaseResourcesExecution
{
template <typename Array>
VTKM_CONT void operator()(Array& array)
{
array.ReleaseResourcesExecution();
}
};
// ArraySizeValidator: ---------------------------------------------------------
// Call Exec(ArrayTuple, NumValues) to ensure that all arrays in the tuple have
// the specified number of values.
template <std::size_t Index, std::size_t Count, typename TupleType>
struct ArraySizeValidatorImpl
{
using Next = ArraySizeValidatorImpl<Index + 1, Count, TupleType>;
VTKM_CONT
static bool Exec(const TupleType& tuple, vtkm::Id numVals)
{
return vtkm::Get<Index>(tuple).GetNumberOfValues() == numVals && Next::Exec(tuple, numVals);
}
};
template <std::size_t Index, typename TupleType>
struct ArraySizeValidatorImpl<Index, Index, TupleType>
{
VTKM_CONT
static bool Exec(const TupleType&, vtkm::Id) { return true; }
};
template <typename TupleType>
struct ArraySizeValidator
{
VTKM_CONT
static bool Exec(const TupleType& tuple, vtkm::Id numVals)
{
return ArraySizeValidatorImpl<0, vtkm::TupleSize<TupleType>::value, TupleType>::Exec(tuple,
numVals);
}
};
template <typename... PortalList>
using AllPortalsAreWritable =
typename brigand::all<brigand::list<PortalList...>,
brigand::bind<vtkm::internal::PortalSupportsSets, brigand::_1>>::type;
// GetFromPortals: -------------------------------------------------------------
// Given a set of array portals as arguments, returns a Vec comprising the values
// at the provided index.
@ -294,7 +106,7 @@ VTKM_EXEC_CONT void SetToPortals(vtkm::Id index, const ValueType& value, const P
portals...);
}
} // end namespace compvec
} // namespace compvec
template <typename... PortalTypes>
class VTKM_ALWAYS_EXPORT ArrayPortalCompositeVector
@ -338,6 +150,54 @@ public:
}
};
}
} // vtkm::internal
namespace vtkm
{
namespace cont
{
namespace internal
{
namespace compvec
{
template <typename ArrayType>
struct VerifyArrayHandle
{
VTKM_STATIC_ASSERT_MSG(vtkm::cont::internal::ArrayHandleCheck<ArrayType>::type::value,
"Template parameters for ArrayHandleCompositeVector "
"must be a list of ArrayHandle types.");
};
template <std::size_t I>
struct BufferIndexImpl
{
template <typename... Ts>
static constexpr vtkm::IdComponent Value(vtkm::IdComponent n, Ts... remaining)
{
return n + BufferIndexImpl<I - 1>::Value(remaining...);
}
};
template <>
struct BufferIndexImpl<0>
{
template <typename... Ts>
static constexpr vtkm::IdComponent Value(Ts...)
{
return 0;
}
};
template <std::size_t I, typename... StorageTypes>
constexpr vtkm::IdComponent BufferIndex()
{
return BufferIndexImpl<I>::Value(StorageTypes::GetNumberOfBuffers()...);
}
} // end namespace compvec
} // namespace internal
template <typename... StorageTags>
@ -354,11 +214,9 @@ struct CompositeVectorTraits
// Need to check this here, since this traits struct is used in the
// ArrayHandleCompositeVector superclass definition before any other
// static_asserts could be used.
VTKM_STATIC_ASSERT_MSG(compvec::AllAreArrayHandles<ArrayTs...>::Value,
"Template parameters for ArrayHandleCompositeVector "
"must be a list of ArrayHandle types.");
using CheckArrayHandles = vtkm::List<compvec::VerifyArrayHandle<ArrayTs>...>;
using ValueType = typename compvec::GetValueType<ArrayTs...>::ValueType;
using ValueType = typename vtkm::internal::compvec::GetValueType<ArrayTs...>::ValueType;
using StorageTag = vtkm::cont::StorageTagCompositeVec<typename ArrayTs::StorageTag...>;
using StorageType = Storage<ValueType, StorageTag>;
using Superclass = ArrayHandle<ValueType, StorageTag>;
@ -368,191 +226,184 @@ template <typename T, typename... StorageTags>
class Storage<vtkm::Vec<T, static_cast<vtkm::IdComponent>(sizeof...(StorageTags))>,
vtkm::cont::StorageTagCompositeVec<StorageTags...>>
{
using ArrayTuple = vtkm::Tuple<vtkm::cont::ArrayHandle<T, StorageTags>...>;
template <typename S>
using StorageFor = vtkm::cont::internal::Storage<T, S>;
ArrayTuple Arrays;
bool Valid;
using StorageTuple = vtkm::Tuple<StorageFor<StorageTags>...>;
template <std::size_t I>
VTKM_CONT static constexpr vtkm::IdComponent BufferIndex()
{
return compvec::BufferIndex<I, StorageFor<StorageTags>...>();
}
template <std::size_t I, typename Buff>
VTKM_CONT static Buff* Buffers(Buff* buffers)
{
return buffers + BufferIndex<I>();
}
using IndexList = vtkmstd::make_index_sequence<sizeof...(StorageTags)>;
public:
using ValueType = vtkm::Vec<T, static_cast<vtkm::IdComponent>(sizeof...(StorageTags))>;
using PortalType = ArrayPortalCompositeVector<
typename vtkm::cont::ArrayHandle<T, StorageTags>::WritePortalType...>;
using PortalConstType =
ArrayPortalCompositeVector<typename vtkm::cont::ArrayHandle<T, StorageTags>::ReadPortalType...>;
VTKM_CONT
Storage()
: Valid(false)
{
}
template <typename... ArrayTypes>
VTKM_CONT Storage(const ArrayTypes&... arrays)
: Arrays(arrays...)
, Valid(true)
{
using SizeValidator = compvec::ArraySizeValidator<ArrayTuple>;
if (!SizeValidator::Exec(this->Arrays, this->GetNumberOfValues()))
{
throw ErrorBadValue("All arrays must have the same number of values.");
}
}
VTKM_CONT
PortalType GetPortal()
{
VTKM_ASSERT(this->Valid);
return this->Arrays.Transform(compvec::WritePortal{});
}
void TypeCheck(int) const;
VTKM_CONT
PortalConstType GetPortalConst() const
{
VTKM_ASSERT(this->Valid);
this->Arrays.Transform(compvec::ReadPortal{});
return this->Arrays.Transform(compvec::ReadPortal{});
}
VTKM_CONT
vtkm::Id GetNumberOfValues() const
{
VTKM_ASSERT(this->Valid);
return vtkm::Get<0>(this->Arrays).GetNumberOfValues();
}
VTKM_CONT
void Allocate(vtkm::Id numValues)
{
VTKM_ASSERT(this->Valid);
this->Arrays.ForEach(compvec::Allocate{ numValues });
}
VTKM_CONT
void Shrink(vtkm::Id numValues)
{
VTKM_ASSERT(this->Valid);
this->Arrays.ForEach(compvec::Shrink{ numValues });
}
VTKM_CONT
void ReleaseResources()
{
VTKM_ASSERT(this->Valid);
this->Arrays.ForEach(compvec::ReleaseResources{});
}
VTKM_CONT
const ArrayTuple& GetArrayTuple() const
{
VTKM_ASSERT(this->Valid);
return this->Arrays;
}
VTKM_CONT
ArrayTuple& GetArrayTuple()
{
VTKM_ASSERT(this->Valid);
return this->Arrays;
}
};
// Special case for single component. Just defer to the original storage.
template <typename T, typename StorageTag>
class Storage<T, vtkm::cont::StorageTagCompositeVec<StorageTag>> : public Storage<T, StorageTag>
{
using ArrayType = vtkm::cont::ArrayHandle<T, StorageTag>;
using TupleType = vtkm::Tuple<ArrayType>;
public:
Storage() = default;
Storage(const ArrayType& array)
: Storage<T, StorageTag>(array.GetStorage())
{
}
VTKM_CONT
const TupleType GetArrayTuple() const { return TupleType(ArrayType(this->GetStoragea())); }
};
template <typename T, typename... StorageTags, typename DeviceTag>
class ArrayTransfer<vtkm::Vec<T, static_cast<vtkm::IdComponent>(sizeof...(StorageTags))>,
vtkm::cont::StorageTagCompositeVec<StorageTags...>,
DeviceTag>
{
VTKM_IS_DEVICE_ADAPTER_TAG(DeviceTag);
using ArrayTuple = vtkm::Tuple<vtkm::cont::ArrayHandle<T, StorageTags>...>;
public:
using ValueType = vtkm::Vec<T, static_cast<vtkm::IdComponent>(sizeof...(StorageTags))>;
using ReadPortalType =
vtkm::internal::ArrayPortalCompositeVector<typename StorageFor<StorageTags>::ReadPortalType...>;
using WritePortalType = vtkm::internal::ArrayPortalCompositeVector<
typename StorageFor<StorageTags>::WritePortalType...>;
private:
using StorageTag = vtkm::cont::StorageTagCompositeVec<StorageTags...>;
using StorageType = internal::Storage<ValueType, StorageTag>;
// Hoop to jump through to use Storage::ResizeBuffer in an initializer list.
template <typename StorageType>
static bool ResizeBuffersCallthrough(StorageType,
vtkm::Id numValues,
vtkm::cont::internal::Buffer* buffers,
vtkm::CopyFlag preserve,
vtkm::cont::Token& token)
{
StorageType::ResizeBuffers(numValues, buffers, preserve, token);
return false; // Return value does not matter. Hopefully just thrown away by compiler.
}
StorageType* Storage;
template <std::size_t... Is>
static void ResizeBuffersImpl(vtkmstd::index_sequence<Is...>,
vtkm::Id numValues,
vtkm::cont::internal::Buffer* buffers,
vtkm::CopyFlag preserve,
vtkm::cont::Token& token)
{
auto init_list = { ResizeBuffersCallthrough(vtkm::tuple_element_t<Is, StorageTuple>{},
numValues,
Buffers<Is>(buffers),
preserve,
token)... };
(void)init_list;
}
template <std::size_t... Is>
static ReadPortalType CreateReadPortalImpl(vtkmstd::index_sequence<Is...>,
const vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
{
return ReadPortalType(vtkm::tuple_element_t<Is, StorageTuple>::CreateReadPortal(
Buffers<Is>(buffers), device, token)...);
}
template <std::size_t... Is>
static WritePortalType CreateWritePortalImpl(vtkmstd::index_sequence<Is...>,
vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
{
return WritePortalType(vtkm::tuple_element_t<Is, StorageTuple>::CreateWritePortal(
Buffers<Is>(buffers), device, token)...);
}
public:
using PortalControl = typename StorageType::PortalType;
using PortalConstControl = typename StorageType::PortalConstType;
using PortalExecution =
ArrayPortalCompositeVector<typename vtkm::cont::ArrayHandle<T, StorageTags>::
template ExecutionTypes<DeviceTag>::Portal...>;
using PortalConstExecution =
ArrayPortalCompositeVector<typename vtkm::cont::ArrayHandle<T, StorageTags>::
template ExecutionTypes<DeviceTag>::PortalConst...>;
VTKM_CONT
ArrayTransfer(StorageType* storage)
: Storage(storage)
VTKM_CONT constexpr static vtkm::IdComponent GetNumberOfBuffers()
{
return BufferIndex<sizeof...(StorageTags)>();
}
VTKM_CONT
vtkm::Id GetNumberOfValues() const { return this->Storage->GetNumberOfValues(); }
VTKM_CONT
PortalConstExecution PrepareForInput(bool vtkmNotUsed(updateData), vtkm::cont::Token& token) const
VTKM_CONT static vtkm::Id GetNumberOfValues(const vtkm::cont::internal::Buffer* buffers)
{
return this->GetArrayTuple().Transform(compvec::PrepareForInput<DeviceTag>{ token });
return vtkm::TupleElement<0, StorageTuple>::GetNumberOfValues(buffers);
}
VTKM_CONT
PortalExecution PrepareForInPlace(bool vtkmNotUsed(updateData), vtkm::cont::Token& token)
VTKM_CONT static void ResizeBuffers(vtkm::Id numValues,
vtkm::cont::internal::Buffer* buffers,
vtkm::CopyFlag preserve,
vtkm::cont::Token& token)
{
return this->GetArrayTuple().Transform(compvec::PrepareForInPlace<DeviceTag>{ token });
ResizeBuffersImpl(IndexList{}, numValues, buffers, preserve, token);
}
VTKM_CONT
PortalExecution PrepareForOutput(vtkm::Id numValues, vtkm::cont::Token& token)
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
{
return this->GetArrayTuple().Transform(
compvec::PrepareForOutput<DeviceTag>{ numValues, token });
return CreateReadPortalImpl(IndexList{}, buffers, device, token);
}
VTKM_CONT
void RetrieveOutputData(StorageType* vtkmNotUsed(storage)) const
VTKM_CONT static WritePortalType CreateWritePortal(vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
{
// Implementation of this method should be unnecessary. The internal
// array handle should automatically retrieve the output data as
// necessary.
return CreateWritePortalImpl(IndexList{}, buffers, device, token);
}
VTKM_CONT
void Shrink(vtkm::Id numValues) { this->GetArrayTuple().ForEach(compvec::Shrink{ numValues }); }
private:
template <typename ArrayType>
VTKM_CONT static bool CopyBuffers(const ArrayType& array,
vtkm::cont::internal::Buffer* destBuffers)
{
vtkm::IdComponent numBuffers = array.GetNumberOfBuffers();
const vtkm::cont::internal::Buffer* srcBuffers = array.GetBuffers();
for (vtkm::IdComponent buffIndex = 0; buffIndex < numBuffers; ++buffIndex)
{
destBuffers[buffIndex] = srcBuffers[buffIndex];
}
return false; // Return value does not matter. Hopefully just thrown away by compiler.
}
VTKM_CONT
void ReleaseResources() { this->GetArrayTuple().ForEach(compvec::ReleaseResourcesExecution{}); }
template <std::size_t... Is, typename... ArrayTs>
VTKM_CONT static std::vector<vtkm::cont::internal::Buffer> CreateBuffersImpl(
vtkmstd::index_sequence<Is...>,
const ArrayTs... arrays)
{
std::vector<vtkm::cont::internal::Buffer> buffers(
static_cast<std::size_t>(GetNumberOfBuffers()));
auto init_list = { CopyBuffers(arrays, Buffers<Is>(&buffers.front()))... };
(void)init_list;
return buffers;
}
VTKM_CONT
const ArrayTuple& GetArrayTuple() const { return this->Storage->GetArrayTuple(); }
ArrayTuple& GetArrayTuple() { return this->Storage->GetArrayTuple(); }
public:
template <typename... ArrayTs>
VTKM_CONT static std::vector<vtkm::cont::internal::Buffer> CreateBuffers(const ArrayTs... arrays)
{
return CreateBuffersImpl(IndexList{}, arrays...);
}
private:
using ArrayTupleType = vtkm::Tuple<vtkm::cont::ArrayHandle<T, StorageTags>...>;
template <std::size_t... Is>
VTKM_CONT static ArrayTupleType GetArrayTupleImpl(vtkmstd::index_sequence<Is...>,
const vtkm::cont::internal::Buffer* buffers)
{
return ArrayTupleType(vtkm::cont::ArrayHandle<T, StorageTags>(Buffers<Is>(buffers))...);
}
public:
VTKM_CONT static ArrayTupleType GetArrayTuple(const vtkm::cont::internal::Buffer* buffers)
{
return GetArrayTupleImpl(IndexList{}, buffers);
}
};
// Special degenerative case when there is only one array being composited
template <typename T, typename StorageTag>
struct Storage<T, vtkm::cont::StorageTagCompositeVec<StorageTag>> : Storage<T, StorageTag>
{
VTKM_CONT static std::vector<vtkm::cont::internal::Buffer> CreateBuffers(
const vtkm::cont::ArrayHandle<T, StorageTag>& array)
{
return vtkm::cont::internal::CreateBuffers(array);
}
VTKM_CONT static vtkm::Tuple<vtkm::cont::ArrayHandle<T, StorageTag>> GetArrayTuple(
const vtkm::cont::internal::Buffer* buffers)
{
return vtkm::cont::ArrayHandle<T, StorageTag>(buffers);
}
};
} // namespace internal
template <typename T, typename... Ss>
VTKM_ARRAY_HANDLE_NEW_STYLE(T, vtkm::cont::StorageTagCompositeVec<Ss...>);
/// \brief An \c ArrayHandle that combines components from other arrays.
///
/// \c ArrayHandleCompositeVector is a specialization of \c ArrayHandle that
@ -573,7 +424,6 @@ class ArrayHandleCompositeVector
{
private:
using Traits = internal::CompositeVectorTraits<ArrayTs...>;
using TupleType = vtkm::Tuple<ArrayTs...>;
using StorageType = typename Traits::StorageType;
public:
@ -583,9 +433,14 @@ public:
VTKM_CONT
ArrayHandleCompositeVector(const ArrayTs&... arrays)
: Superclass(StorageType(arrays...))
: Superclass(StorageType::CreateBuffers(arrays...))
{
}
VTKM_CONT vtkm::Tuple<ArrayTs...> GetArrayTuple() const
{
return StorageType::GetArrayTuple(this->GetBuffers());
}
};
/// Create a composite vector array from other arrays.
@ -594,9 +449,9 @@ template <typename... ArrayTs>
VTKM_CONT ArrayHandleCompositeVector<ArrayTs...> make_ArrayHandleCompositeVector(
const ArrayTs&... arrays)
{
VTKM_STATIC_ASSERT_MSG(internal::compvec::AllAreArrayHandles<ArrayTs...>::Value,
"Arguments to make_ArrayHandleCompositeVector must be "
"of ArrayHandle types.");
// Will issue compiler error if any of ArrayTs is not a valid ArrayHandle.
vtkm::List<internal::compvec::VerifyArrayHandle<ArrayTs>...> checkArrayHandles;
(void)checkArrayHandles;
return ArrayHandleCompositeVector<ArrayTs...>(arrays...);
}
}
@ -677,7 +532,7 @@ private:
public:
static VTKM_CONT void save(BinaryBuffer& bb, const BaseType& obj)
{
obj.GetStorage().GetArrayTuple().ForEach(SaveFunctor{ bb });
Type(obj).GetArrayTuple().ForEach(SaveFunctor{ bb });
}
static VTKM_CONT void load(BinaryBuffer& bb, BaseType& obj)

@ -15,8 +15,6 @@
namespace vtkm
{
namespace cont
{
namespace internal
{
@ -82,6 +80,9 @@ private:
} // namespace internal
namespace cont
{
template <typename ArrayHandleType>
class StorageTagExtractComponent
{
@ -94,160 +95,70 @@ template <typename ArrayHandleType>
class Storage<typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType,
StorageTagExtractComponent<ArrayHandleType>>
{
using SourceValueType = typename ArrayHandleType::ValueType;
using ValueType = typename vtkm::VecTraits<SourceValueType>::ComponentType;
using SourceStorageTag = typename ArrayHandleType::StorageTag;
using SourceStorage = vtkm::cont::internal::Storage<SourceValueType, SourceStorageTag>;
public:
using PortalType = ArrayPortalExtractComponent<typename ArrayHandleType::WritePortalType>;
using PortalConstType = ArrayPortalExtractComponent<typename ArrayHandleType::ReadPortalType>;
using ValueType = typename PortalType::ValueType;
VTKM_CONT
Storage()
: Array()
, Component(0)
, Valid(false)
VTKM_CONT static vtkm::IdComponent ComponentIndex(const vtkm::cont::internal::Buffer* buffers)
{
return buffers[0].GetMetaData<vtkm::IdComponent>();
}
VTKM_CONT
Storage(const ArrayHandleType& array, vtkm::IdComponent component)
: Array(array)
, Component(component)
, Valid(true)
template <typename Buff>
VTKM_CONT static Buff* SourceBuffers(Buff* buffers)
{
return buffers + 1;
}
VTKM_CONT
PortalConstType GetPortalConst() const
using ReadPortalType =
vtkm::internal::ArrayPortalExtractComponent<typename SourceStorage::ReadPortalType>;
using WritePortalType =
vtkm::internal::ArrayPortalExtractComponent<typename SourceStorage::WritePortalType>;
VTKM_CONT constexpr static vtkm::IdComponent GetNumberOfBuffers()
{
VTKM_ASSERT(this->Valid);
return PortalConstType(this->Array.ReadPortal(), this->Component);
return SourceStorage::GetNumberOfBuffers() + 1;
}
VTKM_CONT
PortalType GetPortal()
VTKM_CONT static vtkm::Id GetNumberOfValues(const vtkm::cont::internal::Buffer* buffers)
{
VTKM_ASSERT(this->Valid);
return PortalType(this->Array.WritePortal(), this->Component);
return SourceStorage::GetNumberOfValues(SourceBuffers(buffers));
}
VTKM_CONT
vtkm::Id GetNumberOfValues() const
VTKM_CONT static void ResizeBuffers(vtkm::Id numValues,
vtkm::cont::internal::Buffer* buffers,
vtkm::CopyFlag preserve,
vtkm::cont::Token& token)
{
VTKM_ASSERT(this->Valid);
return this->Array.GetNumberOfValues();
SourceStorage::ResizeBuffers(numValues, SourceBuffers(buffers), preserve, token);
}
VTKM_CONT
void Allocate(vtkm::Id numberOfValues)
VTKM_CONT static ReadPortalType CreateReadPortal(const vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
{
VTKM_ASSERT(this->Valid);
this->Array.Allocate(numberOfValues);
return ReadPortalType(SourceStorage::CreateReadPortal(SourceBuffers(buffers), device, token),
ComponentIndex(buffers));
}
VTKM_CONT
void Shrink(vtkm::Id numberOfValues)
VTKM_CONT static WritePortalType CreateWritePortal(vtkm::cont::internal::Buffer* buffers,
vtkm::cont::DeviceAdapterId device,
vtkm::cont::Token& token)
{
VTKM_ASSERT(this->Valid);
this->Array.Shrink(numberOfValues);
return WritePortalType(SourceStorage::CreateWritePortal(SourceBuffers(buffers), device, token),
ComponentIndex(buffers));
}
VTKM_CONT
void ReleaseResources()
VTKM_CONT static auto CreateBuffers(vtkm::IdComponent componentIndex,
const ArrayHandleType& array)
-> decltype(vtkm::cont::internal::CreateBuffers())
{
VTKM_ASSERT(this->Valid);
this->Array.ReleaseResources();
return vtkm::cont::internal::CreateBuffers(componentIndex, array);
}
VTKM_CONT
const ArrayHandleType& GetArray() const
{
VTKM_ASSERT(this->Valid);
return this->Array;
}
VTKM_CONT
vtkm::IdComponent GetComponent() const
{
VTKM_ASSERT(this->Valid);
return this->Component;
}
private:
ArrayHandleType Array;
vtkm::IdComponent Component;
bool Valid;
}; // class Storage
template <typename ArrayHandleType, typename Device>
class ArrayTransfer<typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType,
StorageTagExtractComponent<ArrayHandleType>,
Device>
{
public:
using ValueType = typename vtkm::VecTraits<typename ArrayHandleType::ValueType>::ComponentType;
private:
using StorageTag = StorageTagExtractComponent<ArrayHandleType>;
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
using ArrayValueType = typename ArrayHandleType::ValueType;
using ArrayStorageTag = typename ArrayHandleType::StorageTag;
using ArrayStorageType =
vtkm::cont::internal::Storage<typename ArrayHandleType::ValueType, ArrayStorageTag>;
public:
using PortalControl = typename StorageType::PortalType;
using PortalConstControl = typename StorageType::PortalConstType;
using ExecutionTypes = typename ArrayHandleType::template ExecutionTypes<Device>;
using PortalExecution = ArrayPortalExtractComponent<typename ExecutionTypes::Portal>;
using PortalConstExecution = ArrayPortalExtractComponent<typename ExecutionTypes::PortalConst>;
VTKM_CONT
ArrayTransfer(StorageType* storage)
: Array(storage->GetArray())
, Component(storage->GetComponent())
{
}
VTKM_CONT
vtkm::Id GetNumberOfValues() const { return this->Array.GetNumberOfValues(); }
VTKM_CONT
PortalConstExecution PrepareForInput(bool vtkmNotUsed(updateData), vtkm::cont::Token& token)
{
return PortalConstExecution(this->Array.PrepareForInput(Device(), token), this->Component);
}
VTKM_CONT
PortalExecution PrepareForInPlace(bool vtkmNotUsed(updateData), vtkm::cont::Token& token)
{
return PortalExecution(this->Array.PrepareForInPlace(Device(), token), this->Component);
}
VTKM_CONT
PortalExecution PrepareForOutput(vtkm::Id numberOfValues, vtkm::cont::Token& token)
{
return PortalExecution(this->Array.PrepareForOutput(numberOfValues, Device(), token),
this->Component);
}
VTKM_CONT
void RetrieveOutputData(StorageType* vtkmNotUsed(storage)) const
{
// Implementation of this method should be unnecessary. The internal
// array handle should automatically retrieve the output data as
// necessary.
}
VTKM_CONT
void Shrink(vtkm::Id numberOfValues) { this->Array.Shrink(numberOfValues); }
VTKM_CONT
void ReleaseResources() { this->Array.ReleaseResourcesExecution(); }
private:
ArrayHandleType Array;
vtkm::IdComponent Component;
};
}
}
} // namespace vtkm::cont::internal
@ -257,6 +168,9 @@ namespace vtkm
namespace cont
{
template <typename T, typename ArrayT>
VTKM_ARRAY_HANDLE_NEW_STYLE(T, vtkm::cont::StorageTagExtractComponent<ArrayT>);
/// \brief A fancy ArrayHandle that turns a vector array into a scalar array by
/// slicing out a single component of each vector.
///
@ -288,9 +202,21 @@ protected:
public:
VTKM_CONT
ArrayHandleExtractComponent(const ArrayHandleType& array, vtkm::IdComponent component)
: Superclass(StorageType(array, component))
: Superclass(StorageType::CreateBuffers(component, array))
{
}
VTKM_CONT vtkm::IdComponent GetComponent() const
{
return StorageType::ComponentIndex(this->GetBuffers());
}
VTKM_CONT ArrayHandleType GetArray() const
{
using BaseArray = vtkm::cont::ArrayHandle<typename ArrayHandleType::ValueType,
typename ArrayHandleType::StorageTag>;
return ArrayHandleType(BaseArray(StorageType::SourceBuffers(this->GetBuffers())));
}
};
/// make_ArrayHandleExtractComponent is convenience function to generate an
@ -346,9 +272,8 @@ private:
public:
static VTKM_CONT void save(BinaryBuffer& bb, const BaseType& obj)
{
auto storage = obj.GetStorage();
vtkmdiy::save(bb, storage.GetComponent());
vtkmdiy::save(bb, storage.GetArray());
vtkmdiy::save(bb, Type(obj).GetComponent());
vtkmdiy::save(bb, Type(obj).GetArray());
}
static VTKM_CONT void load(BinaryBuffer& bb, BaseType& obj)

@ -94,8 +94,12 @@ class Storage
: public vtkm::cont::internal::UndefinedStorage
{
public:
// TODO: Deprecate these
using PortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
using PortalConstType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
using ReadPortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
using WritePortalType = vtkm::cont::internal::detail::UndefinedArrayPortal<T>;
};
#else //VTKM_DOXYGEN_ONLY
{

@ -243,26 +243,6 @@ void TrySpecialArrays()
}
}
void TestBadArrayLengths()
{
std::cout << "Checking behavior when size of input arrays do not agree." << std::endl;
using InArrayType = vtkm::cont::ArrayHandle<vtkm::FloatDefault, StorageTag>;
InArrayType longInArray = MakeInputArray<vtkm::FloatDefault>(0);
InArrayType shortInArray = MakeInputArray<vtkm::FloatDefault>(1);
shortInArray.Shrink(ARRAY_SIZE / 2);
try
{
vtkm::cont::make_ArrayHandleCompositeVector(longInArray, shortInArray);
VTKM_TEST_FAIL("Did not get exception like expected.");
}
catch (vtkm::cont::ErrorBadValue& error)
{
std::cout << "Got expected error: " << std::endl << error.GetMessage() << std::endl;
}
}
void TestCompositeVector()
{
TryScalarArray<2>();
@ -272,8 +252,6 @@ void TestCompositeVector()
TryVector();
TrySpecialArrays();
TestBadArrayLengths();
}
} // anonymous namespace

@ -17,10 +17,28 @@
void TestNGP()
{
const vtkm::Id N = 1000000;
#if 0
// This is a better way to create this array, but I am temporarily breaking this
// functionality (November 2020) so that I can split up merge requests that move
// ArrayHandles to the new buffer types. This should be restored once
// ArrayHandleTransform is converted to the new type.
auto composite = vtkm::cont::make_ArrayHandleCompositeVector(
vtkm::cont::ArrayHandleRandomUniformReal<vtkm::Float32>(N, 0xceed),
vtkm::cont::ArrayHandleRandomUniformReal<vtkm::Float32>(N, 0xdeed),
vtkm::cont::ArrayHandleRandomUniformReal<vtkm::Float32>(N, 0xabba));
#else
vtkm::cont::ArrayHandle<vtkm::Float32> componentArray0;
vtkm::cont::ArrayHandle<vtkm::Float32> componentArray1;
vtkm::cont::ArrayHandle<vtkm::Float32> componentArray2;
vtkm::cont::ArrayCopy(vtkm::cont::ArrayHandleRandomUniformReal<vtkm::Float32>(N, 0xceed),
componentArray0);
vtkm::cont::ArrayCopy(vtkm::cont::ArrayHandleRandomUniformReal<vtkm::Float32>(N, 0xdeed),
componentArray1);
vtkm::cont::ArrayCopy(vtkm::cont::ArrayHandleRandomUniformReal<vtkm::Float32>(N, 0xabba),
componentArray2);
auto composite =
vtkm::cont::make_ArrayHandleCompositeVector(componentArray0, componentArray1, componentArray2);
#endif
vtkm::cont::ArrayHandle<vtkm::Vec3f> positions;
vtkm::cont::ArrayCopy(composite, positions);