mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 10:35:42 +00:00
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.
105 lines
3.5 KiB
C++
105 lines
3.5 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/ArrayHandleReverse.h>
|
|
|
|
#include <vtkm/cont/ArrayHandleIndex.h>
|
|
#include <vtkm/cont/serial/DeviceAdapterSerial.h>
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
namespace UnitTestArrayHandleReverseNamespace
|
|
{
|
|
|
|
const vtkm::Id ARRAY_SIZE = 10;
|
|
|
|
void TestArrayHandleReverseRead()
|
|
{
|
|
vtkm::cont::ArrayHandleIndex array(ARRAY_SIZE);
|
|
VTKM_TEST_ASSERT(array.GetNumberOfValues() == ARRAY_SIZE, "Bad size.");
|
|
|
|
auto portal = array.ReadPortal();
|
|
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
|
|
{
|
|
VTKM_TEST_ASSERT(portal.Get(index) == index, "Index array has unexpected value.");
|
|
}
|
|
|
|
vtkm::cont::ArrayHandleReverse<vtkm::cont::ArrayHandleIndex> reverse =
|
|
vtkm::cont::make_ArrayHandleReverse(array);
|
|
|
|
auto reversedPortal = reverse.ReadPortal();
|
|
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
|
|
{
|
|
VTKM_TEST_ASSERT(reversedPortal.Get(index) == portal.Get(9 - index),
|
|
"ArrayHandleReverse does not reverse array");
|
|
}
|
|
}
|
|
|
|
void TestArrayHandleReverseWrite()
|
|
{
|
|
std::vector<vtkm::Id> ids(ARRAY_SIZE, 0);
|
|
vtkm::cont::ArrayHandle<vtkm::Id> handle = vtkm::cont::make_ArrayHandle(ids, vtkm::CopyFlag::Off);
|
|
|
|
vtkm::cont::ArrayHandleReverse<vtkm::cont::ArrayHandle<vtkm::Id>> reverse =
|
|
vtkm::cont::make_ArrayHandleReverse(handle);
|
|
|
|
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
|
|
{
|
|
reverse.WritePortal().Set(index, index);
|
|
}
|
|
|
|
auto portal = handle.ReadPortal();
|
|
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
|
|
{
|
|
VTKM_TEST_ASSERT(portal.Get(index) == (9 - index), "ArrayHandleReverse does not reverse array");
|
|
}
|
|
}
|
|
|
|
void TestArrayHandleReverseScanInclusiveByKey()
|
|
{
|
|
vtkm::cont::ArrayHandle<vtkm::Id> values =
|
|
vtkm::cont::make_ArrayHandle<vtkm::Id>({ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 });
|
|
vtkm::cont::ArrayHandle<vtkm::Id> keys =
|
|
vtkm::cont::make_ArrayHandle<vtkm::Id>({ 0, 0, 0, 0, 1, 1, 2, 3, 3, 4 });
|
|
|
|
vtkm::cont::ArrayHandle<vtkm::Id> output;
|
|
vtkm::cont::ArrayHandleReverse<vtkm::cont::ArrayHandle<vtkm::Id>> reversed =
|
|
vtkm::cont::make_ArrayHandleReverse(output);
|
|
|
|
using Algorithm = vtkm::cont::DeviceAdapterAlgorithm<vtkm::cont::DeviceAdapterTagSerial>;
|
|
Algorithm::ScanInclusiveByKey(keys, values, reversed);
|
|
|
|
vtkm::cont::ArrayHandleReverse<vtkm::cont::ArrayHandle<vtkm::Id>> expected_reversed =
|
|
vtkm::cont::make_ArrayHandleReverse(
|
|
vtkm::cont::make_ArrayHandle<vtkm::Id>({ 0, 1, 3, 6, 4, 9, 6, 7, 15, 9 }));
|
|
auto outputPortal = output.ReadPortal();
|
|
auto reversePortal = expected_reversed.ReadPortal();
|
|
for (int i = 0; i < 10; i++)
|
|
{
|
|
VTKM_TEST_ASSERT(outputPortal.Get(i) == reversePortal.Get(i),
|
|
"ArrayHandleReverse as output of ScanInclusiveByKey");
|
|
}
|
|
std::cout << std::endl;
|
|
}
|
|
|
|
void TestArrayHandleReverse()
|
|
{
|
|
TestArrayHandleReverseRead();
|
|
TestArrayHandleReverseWrite();
|
|
TestArrayHandleReverseScanInclusiveByKey();
|
|
}
|
|
|
|
}; // namespace UnitTestArrayHandleReverseNamespace
|
|
|
|
int UnitTestArrayHandleReverse(int argc, char* argv[])
|
|
{
|
|
using namespace UnitTestArrayHandleReverseNamespace;
|
|
return vtkm::cont::testing::Testing::Run(TestArrayHandleReverse, argc, argv);
|
|
}
|