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.
108 lines
3.2 KiB
C++
108 lines
3.2 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/ArrayHandleCartesianProduct.h>
|
|
#include <vtkm/cont/DeviceAdapter.h>
|
|
#include <vtkm/cont/DeviceAdapterAlgorithm.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
#include <vector>
|
|
|
|
namespace ArrayHandleCartesianProductNamespace
|
|
{
|
|
|
|
template <typename T>
|
|
void ArrayHandleCPBasic(vtkm::cont::ArrayHandle<T> x,
|
|
vtkm::cont::ArrayHandle<T> y,
|
|
vtkm::cont::ArrayHandle<T> z)
|
|
|
|
{
|
|
vtkm::cont::ArrayHandleCartesianProduct<vtkm::cont::ArrayHandle<T>,
|
|
vtkm::cont::ArrayHandle<T>,
|
|
vtkm::cont::ArrayHandle<T>>
|
|
cpArray;
|
|
|
|
vtkm::Id nx = x.GetNumberOfValues();
|
|
vtkm::Id ny = y.GetNumberOfValues();
|
|
vtkm::Id nz = z.GetNumberOfValues();
|
|
vtkm::Id n = nx * ny * nz;
|
|
|
|
cpArray = vtkm::cont::make_ArrayHandleCartesianProduct(x, y, z);
|
|
|
|
//Make sure we have the right number of values.
|
|
VTKM_TEST_ASSERT(cpArray.GetNumberOfValues() == (nx * ny * nz),
|
|
"Cartesian array constructor has wrong number of values");
|
|
|
|
//Make sure the values are correct.
|
|
vtkm::Vec<T, 3> val;
|
|
auto xPortal = x.ReadPortal();
|
|
auto yPortal = y.ReadPortal();
|
|
auto zPortal = z.ReadPortal();
|
|
auto cpPortal = cpArray.ReadPortal();
|
|
for (vtkm::Id i = 0; i < n; i++)
|
|
{
|
|
vtkm::Id idx0 = (i % (nx * ny)) % nx;
|
|
vtkm::Id idx1 = (i % (nx * ny)) / nx;
|
|
vtkm::Id idx2 = i / (nx * ny);
|
|
|
|
val = vtkm::Vec<T, 3>(xPortal.Get(idx0), yPortal.Get(idx1), zPortal.Get(idx2));
|
|
VTKM_TEST_ASSERT(test_equal(cpPortal.Get(i), val), "Wrong value in array");
|
|
}
|
|
}
|
|
|
|
template <typename T>
|
|
void createArr(std::vector<T>& arr, std::size_t n)
|
|
{
|
|
arr.resize(n);
|
|
for (std::size_t i = 0; i < n; i++)
|
|
arr[i] = static_cast<T>(i);
|
|
}
|
|
|
|
template <typename T>
|
|
void RunTest()
|
|
{
|
|
std::size_t nX = 11, nY = 13, nZ = 11;
|
|
|
|
for (std::size_t i = 1; i < nX; i += 2)
|
|
{
|
|
for (std::size_t j = 1; j < nY; j += 4)
|
|
{
|
|
for (std::size_t k = 1; k < nZ; k += 5)
|
|
{
|
|
std::vector<T> X, Y, Z;
|
|
createArr(X, nX);
|
|
createArr(Y, nY);
|
|
createArr(Z, nZ);
|
|
|
|
ArrayHandleCPBasic(vtkm::cont::make_ArrayHandle(X, vtkm::CopyFlag::Off),
|
|
vtkm::cont::make_ArrayHandle(Y, vtkm::CopyFlag::Off),
|
|
vtkm::cont::make_ArrayHandle(Z, vtkm::CopyFlag::Off));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void TestArrayHandleCartesianProduct()
|
|
{
|
|
RunTest<vtkm::Float32>();
|
|
RunTest<vtkm::Float64>();
|
|
RunTest<vtkm::Id>();
|
|
}
|
|
|
|
} // namespace ArrayHandleCartesianProductNamespace
|
|
|
|
int UnitTestArrayHandleCartesianProduct(int argc, char* argv[])
|
|
{
|
|
using namespace ArrayHandleCartesianProductNamespace;
|
|
return vtkm::cont::testing::Testing::Run(TestArrayHandleCartesianProduct, argc, argv);
|
|
}
|