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.
100 lines
3.4 KiB
C++
100 lines
3.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/AverageByKey.h>
|
|
|
|
#include <vtkm/Hash.h>
|
|
|
|
#include <vtkm/cont/ArrayCopy.h>
|
|
#include <vtkm/cont/ArrayHandleCounting.h>
|
|
|
|
#include <vtkm/cont/testing/Testing.h>
|
|
|
|
namespace
|
|
{
|
|
|
|
static constexpr vtkm::Id NUM_UNIQUE = 100;
|
|
static constexpr vtkm::Id NUM_PER_GROUP = 10;
|
|
static constexpr vtkm::Id ARRAY_SIZE = NUM_UNIQUE * NUM_PER_GROUP;
|
|
|
|
template <typename KeyArray, typename ValueArray>
|
|
void CheckAverageByKey(const KeyArray& uniqueKeys, const ValueArray& averagedValues)
|
|
{
|
|
VTKM_IS_ARRAY_HANDLE(KeyArray);
|
|
VTKM_IS_ARRAY_HANDLE(ValueArray);
|
|
|
|
using KeyType = typename KeyArray::ValueType;
|
|
|
|
VTKM_TEST_ASSERT(uniqueKeys.GetNumberOfValues() == NUM_UNIQUE, "Bad number of keys.");
|
|
VTKM_TEST_ASSERT(averagedValues.GetNumberOfValues() == NUM_UNIQUE, "Bad number of values.");
|
|
|
|
// We expect the unique keys to be sorted, and for the test values to be in order.
|
|
auto keyPortal = uniqueKeys.ReadPortal();
|
|
auto valuePortal = averagedValues.ReadPortal();
|
|
for (vtkm::Id index = 0; index < NUM_UNIQUE; ++index)
|
|
{
|
|
VTKM_TEST_ASSERT(keyPortal.Get(index) == TestValue(index % NUM_UNIQUE, KeyType()),
|
|
"Unexpected key.");
|
|
|
|
vtkm::FloatDefault expectedAverage = static_cast<vtkm::FloatDefault>(
|
|
NUM_PER_GROUP * ((NUM_PER_GROUP - 1) * NUM_PER_GROUP) / 2 + index);
|
|
VTKM_TEST_ASSERT(test_equal(expectedAverage, valuePortal.Get(index)), "Bad average.");
|
|
}
|
|
}
|
|
|
|
template <typename KeyType>
|
|
void TryKeyType(KeyType)
|
|
{
|
|
std::cout << "Testing with " << vtkm::testing::TypeName<KeyType>::Name() << " keys." << std::endl;
|
|
|
|
// Create key array
|
|
KeyType keyBuffer[ARRAY_SIZE];
|
|
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
|
|
{
|
|
keyBuffer[index] = TestValue(index % NUM_UNIQUE, KeyType());
|
|
}
|
|
vtkm::cont::ArrayHandle<KeyType> keysArray =
|
|
vtkm::cont::make_ArrayHandle(keyBuffer, ARRAY_SIZE, vtkm::CopyFlag::Off);
|
|
|
|
// Create Keys object
|
|
vtkm::cont::ArrayHandle<KeyType> sortedKeys;
|
|
vtkm::cont::ArrayCopy(keysArray, sortedKeys);
|
|
vtkm::worklet::Keys<KeyType> keys(sortedKeys);
|
|
VTKM_TEST_ASSERT(keys.GetInputRange() == NUM_UNIQUE, "Keys has bad input range.");
|
|
|
|
// Create values array
|
|
vtkm::cont::ArrayHandleCounting<vtkm::FloatDefault> valuesArray(0.0f, 1.0f, ARRAY_SIZE);
|
|
|
|
std::cout << " Try average with Keys object" << std::endl;
|
|
CheckAverageByKey(keys.GetUniqueKeys(), vtkm::worklet::AverageByKey::Run(keys, valuesArray));
|
|
|
|
std::cout << " Try average with device adapter's reduce by keys" << std::endl;
|
|
vtkm::cont::ArrayHandle<KeyType> outputKeys;
|
|
vtkm::cont::ArrayHandle<vtkm::FloatDefault> outputValues;
|
|
vtkm::worklet::AverageByKey::Run(keysArray, valuesArray, outputKeys, outputValues);
|
|
CheckAverageByKey(outputKeys, outputValues);
|
|
}
|
|
|
|
void DoTest()
|
|
{
|
|
TryKeyType(vtkm::Id());
|
|
TryKeyType(vtkm::IdComponent());
|
|
TryKeyType(vtkm::UInt8());
|
|
TryKeyType(vtkm::HashType());
|
|
TryKeyType(vtkm::Id3());
|
|
}
|
|
|
|
} // anonymous namespace
|
|
|
|
int UnitTestAverageByKey(int argc, char* argv[])
|
|
{
|
|
return vtkm::cont::testing::Testing::Run(DoTest, argc, argv);
|
|
}
|