Merge topic 'array-handle-view'
926f81d9c Add change log for ArrayHandleView 9841d0e2c Add ArrayHandleView Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Robert Maynard <robert.maynard@kitware.com> Merge-request: !1394
This commit is contained in:
Kenneth Moreland
Kitware Robot
commit
4e0e829b81
23
docs/changelog/array-handle-view.md
Normal file
23
docs/changelog/array-handle-view.md
Normal file
@ -0,0 +1,23 @@
|
||||
# Add `ArrayHandleView` fancy array
|
||||
|
||||
Added a new class named `ArrayHandleView` that allows you to get a subset
|
||||
of an array. You use the `ArrayHandleView` by giving it a target array, a
|
||||
starting index, and a length. Here is a simple example of usage:
|
||||
|
||||
``` cpp
|
||||
vtkm::cont::ArrayHandle<vtkm::Id> sourceArray;
|
||||
|
||||
vtkm::cont::ArrayCopy(vtkm::cont::ArrayHandleIndex(10), sourceArray);
|
||||
// sourceArray has [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
|
||||
|
||||
vtkm::cont::ArrayHandleView<vtkm::cont::ArrayHandle<vtkm::Id>>
|
||||
viewArray(sourceArray, 3, 5);
|
||||
// viewArray has [3, 4, 5, 6, 7]
|
||||
```
|
||||
|
||||
There is also a convenience `make_ArraHandleView` function to create view
|
||||
arrays. The following makes the same view array as before.
|
||||
|
||||
``` cpp
|
||||
auto viewArray = vtkm::cont::make_ArrayHandleView(sourceArray, 3, 5);
|
||||
```
|
||||
310
vtkm/cont/ArrayHandleView.h
Normal file
310
vtkm/cont/ArrayHandleView.h
Normal file
@ -0,0 +1,310 @@
|
||||
//============================================================================
|
||||
// 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.
|
||||
//
|
||||
// Copyright 2018 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
|
||||
// Copyright 2018 UT-Battelle, LLC.
|
||||
// Copyright 2018 Los Alamos National Security.
|
||||
//
|
||||
// Under the terms of Contract DE-NA0003525 with NTESS,
|
||||
// the U.S. Government retains certain rights in this software.
|
||||
//
|
||||
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
|
||||
// Laboratory (LANL), the U.S. Government retains certain rights in
|
||||
// this software.
|
||||
//============================================================================
|
||||
#ifndef vtk_m_cont_ArrayHandleView_h
|
||||
#define vtk_m_cont_ArrayHandleView_h
|
||||
|
||||
#include <vtkm/Assert.h>
|
||||
|
||||
#include <vtkm/cont/ArrayHandle.h>
|
||||
#include <vtkm/cont/ArrayPortal.h>
|
||||
|
||||
namespace vtkm
|
||||
{
|
||||
namespace cont
|
||||
{
|
||||
|
||||
namespace internal
|
||||
{
|
||||
|
||||
template <typename TargetPortalType>
|
||||
class ArrayPortalView
|
||||
{
|
||||
public:
|
||||
using ValueType = typename TargetPortalType::ValueType;
|
||||
|
||||
VTKM_SUPPRESS_EXEC_WARNINGS
|
||||
VTKM_EXEC_CONT
|
||||
ArrayPortalView() {}
|
||||
|
||||
VTKM_SUPPRESS_EXEC_WARNINGS
|
||||
VTKM_EXEC_CONT
|
||||
ArrayPortalView(const TargetPortalType& targetPortal, vtkm::Id startIndex, vtkm::Id numValues)
|
||||
: TargetPortal(targetPortal)
|
||||
, StartIndex(startIndex)
|
||||
, NumValues(numValues)
|
||||
{
|
||||
}
|
||||
|
||||
VTKM_SUPPRESS_EXEC_WARNINGS
|
||||
template <typename OtherPortalType>
|
||||
VTKM_EXEC_CONT ArrayPortalView(const ArrayPortalView<OtherPortalType>& otherPortal)
|
||||
: TargetPortal(otherPortal.GetTargetPortal())
|
||||
, StartIndex(otherPortal.GetStartIndex())
|
||||
, NumValues(otherPortal.GetNumberOfValues())
|
||||
{
|
||||
}
|
||||
|
||||
VTKM_EXEC_CONT
|
||||
vtkm::Id GetNumberOfValues() const { return this->NumValues; }
|
||||
|
||||
VTKM_SUPPRESS_EXEC_WARNINGS
|
||||
VTKM_EXEC_CONT
|
||||
ValueType Get(vtkm::Id index) const { return this->TargetPortal.Get(index + this->StartIndex); }
|
||||
|
||||
VTKM_SUPPRESS_EXEC_WARNINGS
|
||||
VTKM_EXEC_CONT
|
||||
void Set(vtkm::Id index, const ValueType& value) const
|
||||
{
|
||||
this->TargetPortal.Set(index + this->StartIndex, value);
|
||||
}
|
||||
|
||||
VTKM_EXEC_CONT
|
||||
const TargetPortalType& GetTargetPortal() const { return this->TargetPortal; }
|
||||
VTKM_EXEC_CONT
|
||||
vtkm::Id GetStartIndex() const { return this->StartIndex; }
|
||||
|
||||
private:
|
||||
TargetPortalType TargetPortal;
|
||||
vtkm::Id StartIndex;
|
||||
vtkm::Id NumValues;
|
||||
};
|
||||
|
||||
} // namespace internal
|
||||
|
||||
template <typename ArrayHandleType>
|
||||
struct StorageTagView
|
||||
{
|
||||
};
|
||||
|
||||
namespace internal
|
||||
{
|
||||
|
||||
template <typename ArrayHandleType>
|
||||
class Storage<typename ArrayHandleType::ValueType, StorageTagView<ArrayHandleType>>
|
||||
{
|
||||
public:
|
||||
using ValueType = typename ArrayHandleType::ValueType;
|
||||
|
||||
using PortalType = ArrayPortalView<typename ArrayHandleType::PortalControl>;
|
||||
using PortalConstType = ArrayPortalView<typename ArrayHandleType::PortalConstControl>;
|
||||
|
||||
VTKM_CONT
|
||||
Storage()
|
||||
: Valid(false)
|
||||
{
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
Storage(const ArrayHandleType& array, vtkm::Id startIndex, vtkm::Id numValues)
|
||||
: Array(array)
|
||||
, StartIndex(startIndex)
|
||||
, NumValues(numValues)
|
||||
, Valid(true)
|
||||
{
|
||||
VTKM_ASSERT(this->StartIndex >= 0);
|
||||
VTKM_ASSERT((this->StartIndex + this->NumValues) <= this->Array.GetNumberOfValues());
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
PortalType GetPortal()
|
||||
{
|
||||
VTKM_ASSERT(this->Valid);
|
||||
return PortalType(this->Array.GetPortalControl(), this->StartIndex, this->NumValues);
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
PortalConstType GetPortalConst() const
|
||||
{
|
||||
VTKM_ASSERT(this->Valid);
|
||||
return PortalConstType(this->Array.GetPortalConstControl(), this->StartIndex, this->NumValues);
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
vtkm::Id GetNumberOfValues() const { return this->NumValues; }
|
||||
|
||||
VTKM_CONT
|
||||
void Allocate(vtkm::Id vtkmNotUsed(numberOfValues))
|
||||
{
|
||||
throw vtkm::cont::ErrorInternal("ArrayHandleView should not be allocated explicitly. ");
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
void Shrink(vtkm::Id numberOfValues)
|
||||
{
|
||||
VTKM_ASSERT(this->Valid);
|
||||
if (numberOfValues > this->NumValues)
|
||||
{
|
||||
throw vtkm::cont::ErrorBadValue("Shrink method cannot be used to grow array.");
|
||||
}
|
||||
|
||||
this->NumValues = numberOfValues;
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
void ReleaseResources()
|
||||
{
|
||||
VTKM_ASSERT(this->Valid);
|
||||
this->Array.ReleaseResources();
|
||||
}
|
||||
|
||||
// Requried for later use in ArrayTransfer class.
|
||||
VTKM_CONT
|
||||
const ArrayHandleType& GetArray() const
|
||||
{
|
||||
VTKM_ASSERT(this->Valid);
|
||||
return this->Array;
|
||||
}
|
||||
VTKM_CONT
|
||||
vtkm::Id GetStartIndex() const { return this->StartIndex; }
|
||||
|
||||
private:
|
||||
ArrayHandleType Array;
|
||||
vtkm::Id StartIndex;
|
||||
vtkm::Id NumValues;
|
||||
bool Valid;
|
||||
};
|
||||
|
||||
template <typename ArrayHandleType, typename Device>
|
||||
class ArrayTransfer<typename ArrayHandleType::ValueType, StorageTagView<ArrayHandleType>, Device>
|
||||
{
|
||||
public:
|
||||
using ValueType = typename ArrayHandleType::ValueType;
|
||||
|
||||
private:
|
||||
using StorageTag = StorageTagView<ArrayHandleType>;
|
||||
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
|
||||
|
||||
public:
|
||||
using PortalControl = typename StorageType::PortalType;
|
||||
using PortalConstControl = typename StorageType::PortalConstType;
|
||||
|
||||
using PortalExecution =
|
||||
ArrayPortalView<typename ArrayHandleType::template ExecutionTypes<Device>::Portal>;
|
||||
using PortalConstExecution =
|
||||
ArrayPortalView<typename ArrayHandleType::template ExecutionTypes<Device>::PortalConst>;
|
||||
|
||||
VTKM_CONT
|
||||
ArrayTransfer(StorageType* storage)
|
||||
: Array(storage->GetArray())
|
||||
, StartIndex(storage->GetStartIndex())
|
||||
, NumValues(storage->GetNumberOfValues())
|
||||
{
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
vtkm::Id GetNumberOfValues() const { return this->NumValues; }
|
||||
|
||||
VTKM_CONT
|
||||
PortalConstExecution PrepareForInput(bool vtkmNotUsed(updateData))
|
||||
{
|
||||
return PortalConstExecution(
|
||||
this->Array.PrepareForInput(Device()), this->StartIndex, this->NumValues);
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
PortalExecution PrepareForInPlace(bool vtkmNotUsed(updateData))
|
||||
{
|
||||
return PortalExecution(
|
||||
this->Array.PrepareForInPlace(Device()), this->StartIndex, this->NumValues);
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
PortalExecution PrepareForOutput(vtkm::Id numberOfValues)
|
||||
{
|
||||
if (numberOfValues != this->GetNumberOfValues())
|
||||
{
|
||||
throw vtkm::cont::ErrorBadValue(
|
||||
"An ArrayHandleView can be used as an output array, "
|
||||
"but it cannot be resized. Make sure the index array is sized "
|
||||
"to the appropriate length before trying to prepare for output.");
|
||||
}
|
||||
|
||||
// We cannot practically allocate ValueArray because we do not know the
|
||||
// range of indices. We try to check by seeing if ValueArray has no
|
||||
// entries, which clearly indicates that it is not allocated. Otherwise,
|
||||
// we have to assume the allocation is correct.
|
||||
if ((numberOfValues > 0) && (this->Array.GetNumberOfValues() < 1))
|
||||
{
|
||||
throw vtkm::cont::ErrorBadValue(
|
||||
"The value array must be pre-allocated before it is used for the "
|
||||
"output of ArrayHandlePermutation.");
|
||||
}
|
||||
|
||||
return PortalExecution(this->Array.PrepareForOutput(this->Array.GetNumberOfValues(), Device()),
|
||||
this->StartIndex,
|
||||
this->NumValues);
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
void RetrieveOutputData(StorageType* vtkmNotUsed(storage)) const
|
||||
{
|
||||
// No implementation necessary
|
||||
}
|
||||
|
||||
VTKM_CONT
|
||||
void Shrink(vtkm::Id numberOfValues) { this->NumValues = numberOfValues; }
|
||||
|
||||
VTKM_CONT
|
||||
void ReleaseResources() { this->Array.ReleaseResourcesExecution(); }
|
||||
|
||||
private:
|
||||
ArrayHandleType Array;
|
||||
vtkm::Id StartIndex;
|
||||
vtkm::Id NumValues;
|
||||
};
|
||||
|
||||
} // namespace internal
|
||||
|
||||
template <typename ArrayHandleType>
|
||||
class ArrayHandleView : public vtkm::cont::ArrayHandle<typename ArrayHandleType::ValueType,
|
||||
StorageTagView<ArrayHandleType>>
|
||||
{
|
||||
VTKM_IS_ARRAY_HANDLE(ArrayHandleType);
|
||||
|
||||
public:
|
||||
VTKM_ARRAY_HANDLE_SUBCLASS(ArrayHandleView,
|
||||
(ArrayHandleView<ArrayHandleType>),
|
||||
(vtkm::cont::ArrayHandle<typename ArrayHandleType::ValueType,
|
||||
StorageTagView<ArrayHandleType>>));
|
||||
|
||||
private:
|
||||
using StorageType = vtkm::cont::internal::Storage<ValueType, StorageTag>;
|
||||
|
||||
public:
|
||||
VTKM_CONT
|
||||
ArrayHandleView(const ArrayHandleType& array, vtkm::Id startIndex, vtkm::Id numValues)
|
||||
: Superclass(StorageType(array, startIndex, numValues))
|
||||
{
|
||||
}
|
||||
};
|
||||
|
||||
template <typename ArrayHandleType>
|
||||
ArrayHandleView<ArrayHandleType> make_ArrayHandleView(const ArrayHandleType& array,
|
||||
vtkm::Id startIndex,
|
||||
vtkm::Id numValues)
|
||||
{
|
||||
VTKM_IS_ARRAY_HANDLE(ArrayHandleType);
|
||||
|
||||
return ArrayHandleView<ArrayHandleType>(array, startIndex, numValues);
|
||||
}
|
||||
}
|
||||
} // namespace vtkm::cont
|
||||
|
||||
#endif //vtk_m_cont_ArrayHandleView_h
|
||||
@ -39,6 +39,7 @@ set(headers
|
||||
ArrayHandleSwizzle.h
|
||||
ArrayHandleTransform.h
|
||||
ArrayHandleUniformPointCoordinates.h
|
||||
ArrayHandleView.h
|
||||
ArrayHandleVirtualCoordinates.h
|
||||
ArrayHandleZip.h
|
||||
ArrayPortal.h
|
||||
|
||||
@ -36,6 +36,7 @@
|
||||
#include <vtkm/cont/ArrayHandleIndex.h>
|
||||
#include <vtkm/cont/ArrayHandlePermutation.h>
|
||||
#include <vtkm/cont/ArrayHandleTransform.h>
|
||||
#include <vtkm/cont/ArrayHandleView.h>
|
||||
#include <vtkm/cont/ArrayHandleZip.h>
|
||||
|
||||
#include <vtkm/worklet/DispatcherMapField.h>
|
||||
@ -392,6 +393,52 @@ private:
|
||||
}
|
||||
};
|
||||
|
||||
struct TestViewAsInput
|
||||
{
|
||||
template <typename ValueType>
|
||||
VTKM_CONT void operator()(const ValueType vtkmNotUsed(v)) const
|
||||
{
|
||||
const vtkm::Id length = ARRAY_SIZE;
|
||||
|
||||
using FunctorType = ::fancy_array_detail::IndexSquared<ValueType>;
|
||||
|
||||
using ValueHandleType = vtkm::cont::ArrayHandleImplicit<FunctorType>;
|
||||
using ViewHandleType = vtkm::cont::ArrayHandleView<ValueHandleType>;
|
||||
|
||||
FunctorType functor;
|
||||
for (vtkm::Id start_pos = 0; start_pos < length; start_pos += length / 4)
|
||||
{
|
||||
const vtkm::Id counting_length = length - start_pos;
|
||||
|
||||
ValueHandleType implicit = vtkm::cont::make_ArrayHandleImplicit(functor, length);
|
||||
|
||||
ViewHandleType view =
|
||||
vtkm::cont::make_ArrayHandleView(implicit, start_pos, counting_length);
|
||||
|
||||
vtkm::cont::printSummary_ArrayHandle(view, std::cout);
|
||||
std::cout << std::endl;
|
||||
|
||||
vtkm::cont::ArrayHandle<ValueType> result;
|
||||
|
||||
vtkm::worklet::DispatcherMapField<PassThrough, DeviceAdapterTag> dispatcher;
|
||||
dispatcher.Invoke(view, result);
|
||||
|
||||
//verify that the control portal works
|
||||
for (vtkm::Id i = 0; i < counting_length; ++i)
|
||||
{
|
||||
const vtkm::Id value_index = i;
|
||||
const vtkm::Id key_index = start_pos + i;
|
||||
|
||||
const ValueType result_v = result.GetPortalConstControl().Get(value_index);
|
||||
const ValueType correct_value = implicit.GetPortalConstControl().Get(key_index);
|
||||
const ValueType control_value = view.GetPortalConstControl().Get(value_index);
|
||||
VTKM_TEST_ASSERT(test_equal(result_v, correct_value), "Implicit Handle Failed");
|
||||
VTKM_TEST_ASSERT(test_equal(result_v, control_value), "Implicit Handle Failed");
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
struct TestTransformAsInput
|
||||
{
|
||||
template <typename ValueType>
|
||||
@ -829,6 +876,47 @@ private:
|
||||
}
|
||||
};
|
||||
|
||||
struct TestViewAsOutput
|
||||
{
|
||||
template <typename ValueType>
|
||||
VTKM_CONT void operator()(const ValueType vtkmNotUsed(v)) const
|
||||
{
|
||||
const vtkm::Id length = ARRAY_SIZE;
|
||||
|
||||
using ValueHandleType = vtkm::cont::ArrayHandle<ValueType>;
|
||||
using ViewHandleType = vtkm::cont::ArrayHandleView<ValueHandleType>;
|
||||
|
||||
using ComponentType = typename vtkm::VecTraits<ValueType>::ComponentType;
|
||||
vtkm::cont::ArrayHandle<ValueType> input;
|
||||
using Portal = typename vtkm::cont::ArrayHandle<ValueType>::PortalControl;
|
||||
input.Allocate(length);
|
||||
Portal inputPortal = input.GetPortalControl();
|
||||
for (vtkm::Id i = 0; i < length; ++i)
|
||||
{
|
||||
inputPortal.Set(i, ValueType(ComponentType(i)));
|
||||
}
|
||||
|
||||
ValueHandleType values;
|
||||
values.Allocate(length * 2);
|
||||
|
||||
ViewHandleType view = vtkm::cont::make_ArrayHandleView(values, length, length);
|
||||
vtkm::worklet::DispatcherMapField<PassThrough, DeviceAdapterTag> dispatcher;
|
||||
dispatcher.Invoke(input, view);
|
||||
|
||||
vtkm::cont::printSummary_ArrayHandle(view, std::cout);
|
||||
std::cout << std::endl;
|
||||
|
||||
//verify that the control portal works
|
||||
for (vtkm::Id i = 0; i < length; ++i)
|
||||
{
|
||||
const ValueType result_v = view.GetPortalConstControl().Get(i);
|
||||
const ValueType correct_value = ValueType(ComponentType(i));
|
||||
VTKM_TEST_ASSERT(test_equal(result_v, correct_value),
|
||||
"Permutation Handle Failed As Output");
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
struct TestZipAsOutput
|
||||
{
|
||||
template <typename KeyType, typename ValueType>
|
||||
@ -949,6 +1037,11 @@ private:
|
||||
vtkm::testing::Testing::TryTypes(
|
||||
TestingFancyArrayHandles<DeviceAdapterTag>::TestPermutationAsInput(), HandleTypesToTest());
|
||||
|
||||
std::cout << "-------------------------------------------" << std::endl;
|
||||
std::cout << "Testing ArrayHandleView as Input" << std::endl;
|
||||
vtkm::testing::Testing::TryTypes(
|
||||
TestingFancyArrayHandles<DeviceAdapterTag>::TestViewAsInput(), HandleTypesToTest());
|
||||
|
||||
std::cout << "-------------------------------------------" << std::endl;
|
||||
std::cout << "Testing ArrayHandleTransform as Input" << std::endl;
|
||||
vtkm::testing::Testing::TryTypes(
|
||||
@ -1007,6 +1100,11 @@ private:
|
||||
vtkm::testing::Testing::TryTypes(
|
||||
TestingFancyArrayHandles<DeviceAdapterTag>::TestPermutationAsOutput(), HandleTypesToTest());
|
||||
|
||||
std::cout << "-------------------------------------------" << std::endl;
|
||||
std::cout << "Testing ArrayHandleView as Output" << std::endl;
|
||||
vtkm::testing::Testing::TryTypes(
|
||||
TestingFancyArrayHandles<DeviceAdapterTag>::TestViewAsOutput(), HandleTypesToTest());
|
||||
|
||||
std::cout << "-------------------------------------------" << std::endl;
|
||||
std::cout << "Testing ArrayHandleDiscard as Output" << std::endl;
|
||||
vtkm::testing::Testing::TryTypes(
|
||||
|
||||
Loading…
Reference in New Issue
Block a user