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.
155 lines
4.6 KiB
C++
155 lines
4.6 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/ArrayCopy.h>
|
|
#include <vtkm/cont/ArrayGetValues.h>
|
|
#include <vtkm/cont/ArrayHandleIndex.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
namespace
|
|
{
|
|
|
|
static constexpr vtkm::Id ARRAY_SIZE = 10;
|
|
|
|
template <typename T>
|
|
VTKM_CONT void TestValues(const vtkm::cont::ArrayHandle<T>& ah,
|
|
const std::initializer_list<T>& expected)
|
|
{
|
|
auto portal = ah.ReadPortal();
|
|
VTKM_TEST_ASSERT(expected.size() == static_cast<size_t>(ah.GetNumberOfValues()));
|
|
for (vtkm::Id i = 0; i < ah.GetNumberOfValues(); ++i)
|
|
{
|
|
VTKM_TEST_ASSERT(expected.begin()[static_cast<size_t>(i)] == portal.Get(i));
|
|
}
|
|
}
|
|
|
|
template <typename T>
|
|
VTKM_CONT void TestValues(const std::vector<T>& vec, const std::initializer_list<T>& expected)
|
|
{
|
|
VTKM_TEST_ASSERT(expected.size() == vec.size());
|
|
for (std::size_t i = 0; i < vec.size(); ++i)
|
|
{
|
|
VTKM_TEST_ASSERT(expected.begin()[static_cast<size_t>(i)] == vec[i]);
|
|
}
|
|
}
|
|
|
|
template <typename ValueType>
|
|
void TryCopy()
|
|
{
|
|
std::cout << "Trying type: " << vtkm::testing::TypeName<ValueType>::Name() << std::endl;
|
|
|
|
vtkm::cont::ArrayHandle<ValueType> data;
|
|
{ // Create the ValueType array.
|
|
vtkm::cont::ArrayHandleIndex values(ARRAY_SIZE);
|
|
vtkm::cont::ArrayCopy(values, data);
|
|
}
|
|
|
|
{ // ArrayHandle ids
|
|
const auto ids = vtkm::cont::make_ArrayHandle<vtkm::Id>({ 3, 8, 7 });
|
|
{ // Return vector:
|
|
const std::vector<ValueType> output = vtkm::cont::ArrayGetValues(ids, data);
|
|
TestValues<ValueType>(output, { 3, 8, 7 });
|
|
}
|
|
{ // Pass vector:
|
|
std::vector<ValueType> output;
|
|
vtkm::cont::ArrayGetValues(ids, data, output);
|
|
TestValues<ValueType>(output, { 3, 8, 7 });
|
|
}
|
|
{ // Pass handle:
|
|
vtkm::cont::ArrayHandle<ValueType> output;
|
|
vtkm::cont::ArrayGetValues(ids, data, output);
|
|
TestValues<ValueType>(output, { 3, 8, 7 });
|
|
}
|
|
}
|
|
|
|
{ // vector ids
|
|
const std::vector<vtkm::Id> ids{ 1, 5, 3, 9 };
|
|
{ // Return vector:
|
|
const std::vector<ValueType> output = vtkm::cont::ArrayGetValues(ids, data);
|
|
TestValues<ValueType>(output, { 1, 5, 3, 9 });
|
|
}
|
|
{ // Pass vector:
|
|
std::vector<ValueType> output;
|
|
vtkm::cont::ArrayGetValues(ids, data, output);
|
|
TestValues<ValueType>(output, { 1, 5, 3, 9 });
|
|
}
|
|
{ // Pass handle:
|
|
vtkm::cont::ArrayHandle<ValueType> output;
|
|
vtkm::cont::ArrayGetValues(ids, data, output);
|
|
TestValues<ValueType>(output, { 1, 5, 3, 9 });
|
|
}
|
|
}
|
|
|
|
{ // Initializer list ids
|
|
{ // Return vector:
|
|
const std::vector<ValueType> output = vtkm::cont::ArrayGetValues({ 4, 2, 0, 6, 9 }, data);
|
|
TestValues<ValueType>(output, { 4, 2, 0, 6, 9 });
|
|
}
|
|
{ // Pass vector:
|
|
std::vector<ValueType> output;
|
|
vtkm::cont::ArrayGetValues({ 4, 2, 0, 6, 9 }, data, output);
|
|
TestValues<ValueType>(output, { 4, 2, 0, 6, 9 });
|
|
}
|
|
{ // Pass handle:
|
|
vtkm::cont::ArrayHandle<ValueType> output;
|
|
vtkm::cont::ArrayGetValues({ 4, 2, 0, 6, 9 }, data, output);
|
|
TestValues<ValueType>(output, { 4, 2, 0, 6, 9 });
|
|
}
|
|
}
|
|
|
|
{ // c-array ids
|
|
const std::vector<vtkm::Id> idVec{ 8, 6, 7, 5, 3, 0, 9 };
|
|
const vtkm::Id* ids = idVec.data();
|
|
const vtkm::Id n = static_cast<vtkm::Id>(idVec.size());
|
|
{ // Return vector:
|
|
const std::vector<ValueType> output = vtkm::cont::ArrayGetValues(ids, n, data);
|
|
TestValues<ValueType>(output, { 8, 6, 7, 5, 3, 0, 9 });
|
|
}
|
|
{ // Pass vector:
|
|
std::vector<ValueType> output;
|
|
vtkm::cont::ArrayGetValues(ids, n, data, output);
|
|
TestValues<ValueType>(output, { 8, 6, 7, 5, 3, 0, 9 });
|
|
}
|
|
{ // Pass handle:
|
|
vtkm::cont::ArrayHandle<ValueType> output;
|
|
vtkm::cont::ArrayGetValues(ids, n, data, output);
|
|
TestValues<ValueType>(output, { 8, 6, 7, 5, 3, 0, 9 });
|
|
}
|
|
}
|
|
|
|
|
|
{ // single values
|
|
{
|
|
const ValueType output = vtkm::cont::ArrayGetValue(8, data);
|
|
VTKM_TEST_ASSERT(output == static_cast<ValueType>(8));
|
|
}
|
|
{
|
|
ValueType output;
|
|
vtkm::cont::ArrayGetValue(8, data, output);
|
|
VTKM_TEST_ASSERT(output == static_cast<ValueType>(8));
|
|
}
|
|
}
|
|
}
|
|
|
|
void Test()
|
|
{
|
|
TryCopy<vtkm::Id>();
|
|
TryCopy<vtkm::IdComponent>();
|
|
TryCopy<vtkm::Float32>();
|
|
}
|
|
|
|
} // anonymous namespace
|
|
|
|
int UnitTestArrayGetValues(int argc, char* argv[])
|
|
{
|
|
return vtkm::cont::testing::Testing::Run(Test, argc, argv);
|
|
}
|