mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 18:45:43 +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.
136 lines
4.4 KiB
C++
136 lines
4.4 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/worklet/DispatcherMapField.h>
|
|
#include <vtkm/worklet/Normalize.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
namespace
|
|
{
|
|
|
|
template <typename T>
|
|
void createVectors(std::vector<vtkm::Vec<T, 3>>& vecs)
|
|
{
|
|
vecs.push_back(vtkm::make_Vec(2, 0, 0));
|
|
vecs.push_back(vtkm::make_Vec(0, 2, 0));
|
|
vecs.push_back(vtkm::make_Vec(0, 0, 2));
|
|
vecs.push_back(vtkm::make_Vec(1, 1, 1));
|
|
vecs.push_back(vtkm::make_Vec(2, 2, 2));
|
|
vecs.push_back(vtkm::make_Vec(2, 1, 1));
|
|
|
|
vecs.push_back(vtkm::make_Vec(1000000, 0, 0));
|
|
|
|
vecs.push_back(vtkm::make_Vec(static_cast<T>(.1), static_cast<T>(0), static_cast<T>(0)));
|
|
vecs.push_back(vtkm::make_Vec(static_cast<T>(.001), static_cast<T>(0), static_cast<T>(0)));
|
|
}
|
|
|
|
template <typename T>
|
|
void createVectors(std::vector<vtkm::Vec<T, 2>>& vecs)
|
|
{
|
|
vecs.push_back(vtkm::make_Vec(1, 0));
|
|
vecs.push_back(vtkm::make_Vec(0, 1));
|
|
vecs.push_back(vtkm::make_Vec(1, 1));
|
|
vecs.push_back(vtkm::make_Vec(2, 0));
|
|
vecs.push_back(vtkm::make_Vec(0, 2));
|
|
vecs.push_back(vtkm::make_Vec(2, 2));
|
|
|
|
vecs.push_back(vtkm::make_Vec(1000000, 0));
|
|
|
|
vecs.push_back(vtkm::make_Vec(static_cast<T>(.1), static_cast<T>(0)));
|
|
vecs.push_back(vtkm::make_Vec(static_cast<T>(.001), static_cast<T>(0)));
|
|
}
|
|
|
|
template <typename T, int N>
|
|
void TestNormal()
|
|
{
|
|
std::vector<vtkm::Vec<T, N>> inputVecs;
|
|
createVectors(inputVecs);
|
|
|
|
vtkm::cont::ArrayHandle<vtkm::Vec<T, N>> inputArray;
|
|
vtkm::cont::ArrayHandle<vtkm::Vec<T, N>> outputArray;
|
|
inputArray = vtkm::cont::make_ArrayHandle(inputVecs, vtkm::CopyFlag::On);
|
|
|
|
vtkm::worklet::Normal normalWorklet;
|
|
vtkm::worklet::DispatcherMapField<vtkm::worklet::Normal> dispatcherNormal(normalWorklet);
|
|
dispatcherNormal.Invoke(inputArray, outputArray);
|
|
|
|
//Validate results.
|
|
|
|
//Make sure the number of values match.
|
|
VTKM_TEST_ASSERT(outputArray.GetNumberOfValues() == inputArray.GetNumberOfValues(),
|
|
"Wrong number of results for Normalize worklet");
|
|
|
|
//Make sure each vector is correct.
|
|
for (vtkm::Id i = 0; i < inputArray.GetNumberOfValues(); i++)
|
|
{
|
|
//Make sure that the value is correct.
|
|
vtkm::Vec<T, N> v = inputArray.ReadPortal().Get(i);
|
|
vtkm::Vec<T, N> vN = outputArray.ReadPortal().Get(i);
|
|
T len = vtkm::Magnitude(v);
|
|
VTKM_TEST_ASSERT(test_equal(v / len, vN), "Wrong result for Normalize worklet");
|
|
|
|
//Make sure the magnitudes are all 1.0
|
|
len = vtkm::Magnitude(vN);
|
|
VTKM_TEST_ASSERT(test_equal(len, 1), "Wrong magnitude for Normalize worklet");
|
|
}
|
|
}
|
|
|
|
template <typename T, int N>
|
|
void TestNormalize()
|
|
{
|
|
std::vector<vtkm::Vec<T, N>> inputVecs;
|
|
createVectors(inputVecs);
|
|
|
|
vtkm::cont::ArrayHandle<vtkm::Vec<T, N>> inputArray;
|
|
vtkm::cont::ArrayHandle<vtkm::Vec<T, N>> outputArray;
|
|
inputArray = vtkm::cont::make_ArrayHandle(inputVecs, vtkm::CopyFlag::On);
|
|
|
|
vtkm::worklet::Normalize normalizeWorklet;
|
|
vtkm::worklet::DispatcherMapField<vtkm::worklet::Normalize> dispatcherNormalize(normalizeWorklet);
|
|
dispatcherNormalize.Invoke(inputArray);
|
|
|
|
//Make sure each vector is correct.
|
|
for (vtkm::Id i = 0; i < inputArray.GetNumberOfValues(); i++)
|
|
{
|
|
//Make sure that the value is correct.
|
|
vtkm::Vec<T, N> v = inputVecs[static_cast<std::size_t>(i)];
|
|
vtkm::Vec<T, N> vN = inputArray.ReadPortal().Get(i);
|
|
T len = vtkm::Magnitude(v);
|
|
VTKM_TEST_ASSERT(test_equal(v / len, vN), "Wrong result for Normalize worklet");
|
|
|
|
//Make sure the magnitudes are all 1.0
|
|
len = vtkm::Magnitude(vN);
|
|
VTKM_TEST_ASSERT(test_equal(len, 1), "Wrong magnitude for Normalize worklet");
|
|
}
|
|
}
|
|
|
|
void TestNormalWorklets()
|
|
{
|
|
std::cout << "Testing Normal Worklet" << std::endl;
|
|
|
|
TestNormal<vtkm::Float32, 2>();
|
|
TestNormal<vtkm::Float64, 2>();
|
|
TestNormal<vtkm::Float32, 3>();
|
|
TestNormal<vtkm::Float64, 3>();
|
|
|
|
std::cout << "Testing Normalize Worklet" << std::endl;
|
|
TestNormalize<vtkm::Float32, 2>();
|
|
TestNormalize<vtkm::Float64, 2>();
|
|
TestNormalize<vtkm::Float32, 3>();
|
|
TestNormalize<vtkm::Float64, 3>();
|
|
}
|
|
}
|
|
|
|
int UnitTestNormalize(int argc, char* argv[])
|
|
{
|
|
return vtkm::cont::testing::Testing::Run(TestNormalWorklets, argc, argv);
|
|
}
|