d1a4aecc59
We have made several improvements to adding data into an `ArrayHandle`. ## Moving data from an `std::vector` For numerous reasons, it is convenient to define data in a `std::vector` and then wrap that into an `ArrayHandle`. It is often the case that an `std::vector` is filled and then becomes unused once it is converted to an `ArrayHandle`. In this case, what we really want is to pass the data off to the `ArrayHandle` so that the `ArrayHandle` is now managing the data and not the `std::vector`. C++11 has a mechanism to do this: move semantics. You can now pass variables to functions as an "rvalue" (right-hand value). When something is passed as an rvalue, it can pull state out of that variable and move it somewhere else. `std::vector` implements this movement so that an rvalue can be moved to another `std::vector` without actually copying the data. `make_ArrayHandle` now also takes advantage of this feature to move rvalue `std::vector`s. There is a special form of `make_ArrayHandle` named `make_ArrayHandleMove` that takes an rvalue. There is also a special overload of `make_ArrayHandle` itself that handles an rvalue `vector`. (However, using the explicit move version is better if you want to make sure the data is actually moved.) ## Make `ArrayHandle` from initalizer list A common use case for using `std::vector` (particularly in our unit tests) is to quickly add an initalizer list into an `ArrayHandle`. Now you can by simply passing an initializer list to `make_ArrayHandle`. ## Deprecated `make_ArrayHandle` with default shallow copy For historical reasons, passing an `std::vector` or a pointer to `make_ArrayHandle` does a shallow copy (i.e. `CopyFlag` defaults to `Off`). Although more efficient, this mode is inherintly unsafe, and making it the default is asking for trouble. To combat this, calling `make_ArrayHandle` without a copy flag is deprecated. In this way, if you wish to do the faster but more unsafe creation of an `ArrayHandle` you should explicitly express that. This requried quite a few changes through the VTK-m source (particularly in the tests). ## Similar changes to `Field` `vtkm::cont::Field` has a `make_Field` helper function that is similar to `make_ArrayHandle`. It also features the ability to create fields from `std::vector`s and C arrays. It also likewise had the same unsafe behavior by default of not copying from the source of the arrays. That behavior has similarly been depreciated. You now have to specify a copy flag. The ability to construct a `Field` from an initializer list of values has also been added.
123 lines
4.1 KiB
C++
123 lines
4.1 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.
|
|
//============================================================================
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/ArrayHandleIndex.h>
|
|
#include <vtkm/cont/ExecutionObjectBase.h>
|
|
#include <vtkm/cont/VariantArrayHandle.h>
|
|
|
|
#include <vtkm/worklet/DispatcherMapField.h>
|
|
#include <vtkm/worklet/WorkletMapField.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
struct SimpleExecObject : vtkm::cont::ExecutionObjectBase
|
|
{
|
|
template <typename Device>
|
|
Device PrepareForExecution(Device, vtkm::cont::Token&) const
|
|
{
|
|
return Device();
|
|
}
|
|
};
|
|
|
|
struct TestExecObjectWorklet
|
|
{
|
|
template <typename T>
|
|
class Worklet : public vtkm::worklet::WorkletMapField
|
|
{
|
|
public:
|
|
using ControlSignature = void(FieldIn, WholeArrayIn, WholeArrayOut, FieldOut, ExecObject);
|
|
using ExecutionSignature = void(_1, _2, _3, _4, _5, Device);
|
|
|
|
template <typename InPortalType, typename OutPortalType, typename DeviceTag>
|
|
VTKM_EXEC void operator()(const vtkm::Id& index,
|
|
const InPortalType& execIn,
|
|
OutPortalType& execOut,
|
|
T& out,
|
|
DeviceTag,
|
|
DeviceTag) const
|
|
{
|
|
VTKM_IS_DEVICE_ADAPTER_TAG(DeviceTag);
|
|
|
|
if (!test_equal(execIn.Get(index), TestValue(index, T()) + T(100)))
|
|
{
|
|
this->RaiseError("Got wrong input value.");
|
|
}
|
|
out = static_cast<T>(execIn.Get(index) - T(100));
|
|
execOut.Set(index, out);
|
|
}
|
|
};
|
|
};
|
|
|
|
namespace map_exec_field
|
|
{
|
|
|
|
static constexpr vtkm::Id ARRAY_SIZE = 10;
|
|
|
|
template <typename WorkletType>
|
|
struct DoTestWorklet
|
|
{
|
|
template <typename T>
|
|
VTKM_CONT void operator()(T) const
|
|
{
|
|
std::cout << "Set up data." << std::endl;
|
|
T inputArray[ARRAY_SIZE];
|
|
|
|
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
|
|
{
|
|
inputArray[index] = static_cast<T>(TestValue(index, T()) + T(100));
|
|
}
|
|
|
|
vtkm::cont::ArrayHandleIndex counting(ARRAY_SIZE);
|
|
vtkm::cont::ArrayHandle<T> inputHandle =
|
|
vtkm::cont::make_ArrayHandle(inputArray, ARRAY_SIZE, vtkm::CopyFlag::Off);
|
|
vtkm::cont::ArrayHandle<T> outputHandle;
|
|
vtkm::cont::ArrayHandle<T> outputFieldArray;
|
|
outputHandle.Allocate(ARRAY_SIZE);
|
|
|
|
std::cout << "Create and run dispatcher." << std::endl;
|
|
vtkm::worklet::DispatcherMapField<typename WorkletType::template Worklet<T>> dispatcher;
|
|
dispatcher.Invoke(counting, inputHandle, outputHandle, outputFieldArray, SimpleExecObject());
|
|
|
|
std::cout << "Check result." << std::endl;
|
|
CheckPortal(outputHandle.ReadPortal());
|
|
CheckPortal(outputFieldArray.ReadPortal());
|
|
|
|
std::cout << "Repeat with dynamic arrays." << std::endl;
|
|
// Clear out output arrays.
|
|
outputFieldArray = vtkm::cont::ArrayHandle<T>();
|
|
outputHandle = vtkm::cont::ArrayHandle<T>();
|
|
outputHandle.Allocate(ARRAY_SIZE);
|
|
|
|
vtkm::cont::VariantArrayHandleBase<vtkm::List<T>> outputFieldDynamic(outputFieldArray);
|
|
dispatcher.Invoke(counting, inputHandle, outputHandle, outputFieldDynamic, SimpleExecObject());
|
|
|
|
std::cout << "Check dynamic array result." << std::endl;
|
|
CheckPortal(outputHandle.ReadPortal());
|
|
CheckPortal(outputFieldArray.ReadPortal());
|
|
}
|
|
};
|
|
|
|
void TestWorkletMapFieldExecArg(vtkm::cont::DeviceAdapterId id)
|
|
{
|
|
std::cout << "Testing Worklet with WholeArray on device adapter: " << id.GetName() << std::endl;
|
|
|
|
std::cout << "--- Worklet accepting all types." << std::endl;
|
|
vtkm::testing::Testing::TryTypes(map_exec_field::DoTestWorklet<TestExecObjectWorklet>(),
|
|
vtkm::TypeListCommon());
|
|
}
|
|
|
|
} // anonymous namespace
|
|
|
|
int UnitTestWorkletMapFieldExecArg(int argc, char* argv[])
|
|
{
|
|
return vtkm::cont::testing::Testing::RunOnDevice(
|
|
map_exec_field::TestWorkletMapFieldExecArg, argc, argv);
|
|
}
|