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.
76 lines
2.6 KiB
C++
76 lines
2.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/ArrayHandleConcatenate.h>
|
|
#include <vtkm/cont/ArrayHandleIndex.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
namespace UnitTestArrayHandleConcatenateNamespace
|
|
{
|
|
|
|
const vtkm::Id ARRAY_SIZE = 5;
|
|
|
|
void TestArrayHandleConcatenate()
|
|
{
|
|
vtkm::cont::ArrayHandleIndex array1(ARRAY_SIZE);
|
|
vtkm::cont::ArrayHandleIndex array2(2 * ARRAY_SIZE);
|
|
|
|
vtkm::cont::ArrayHandleConcatenate<vtkm::cont::ArrayHandleIndex, vtkm::cont::ArrayHandleIndex>
|
|
array3(array1, array2);
|
|
|
|
vtkm::cont::ArrayHandleIndex array4(ARRAY_SIZE);
|
|
vtkm::cont::ArrayHandleConcatenate<
|
|
vtkm::cont::ArrayHandleConcatenate<vtkm::cont::ArrayHandleIndex, // 1st
|
|
vtkm::cont::ArrayHandleIndex>, // ArrayHandle
|
|
vtkm::cont::ArrayHandleIndex> // 2nd ArrayHandle
|
|
array5;
|
|
{
|
|
array5 = vtkm::cont::make_ArrayHandleConcatenate(array3, array4);
|
|
}
|
|
|
|
auto array5Portal = array5.ReadPortal();
|
|
for (vtkm::Id index = 0; index < array5.GetNumberOfValues(); index++)
|
|
{
|
|
std::cout << array5Portal.Get(index) << std::endl;
|
|
}
|
|
}
|
|
|
|
void TestConcatenateEmptyArray()
|
|
{
|
|
std::vector<vtkm::Float64> vec;
|
|
for (vtkm::Id i = 0; i < ARRAY_SIZE; i++)
|
|
vec.push_back(vtkm::Float64(i) * 1.5);
|
|
|
|
using CoeffValueType = vtkm::Float64;
|
|
using CoeffArrayTypeTmp = vtkm::cont::ArrayHandle<CoeffValueType>;
|
|
using ArrayConcat = vtkm::cont::ArrayHandleConcatenate<CoeffArrayTypeTmp, CoeffArrayTypeTmp>;
|
|
using ArrayConcat2 = vtkm::cont::ArrayHandleConcatenate<ArrayConcat, CoeffArrayTypeTmp>;
|
|
|
|
CoeffArrayTypeTmp arr1 = vtkm::cont::make_ArrayHandle(vec, vtkm::CopyFlag::Off);
|
|
CoeffArrayTypeTmp arr2, arr3;
|
|
|
|
ArrayConcat arrConc(arr2, arr1);
|
|
ArrayConcat2 arrConc2(arrConc, arr3);
|
|
|
|
auto arrConc2Portal = arrConc2.ReadPortal();
|
|
for (vtkm::Id i = 0; i < arrConc2.GetNumberOfValues(); i++)
|
|
std::cout << arrConc2Portal.Get(i) << std::endl;
|
|
}
|
|
|
|
} // namespace UnitTestArrayHandleIndexNamespace
|
|
|
|
int UnitTestArrayHandleConcatenate(int argc, char* argv[])
|
|
{
|
|
using namespace UnitTestArrayHandleConcatenateNamespace;
|
|
//TestConcatenateEmptyArray();
|
|
return vtkm::cont::testing::Testing::Run(TestArrayHandleConcatenate, argc, argv);
|
|
}
|