vtk-m/vtkm/cont/testing/UnitTestDynamicArrayHandle.cxx

429 lines
14 KiB
C++
Raw Normal View History

//============================================================================
// 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.
//
// Copyright 2014 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
// Copyright 2014 UT-Battelle, LLC.
// Copyright 2014 Los Alamos National Security.
//
// Under the terms of Contract DE-NA0003525 with NTESS,
// the U.S. Government retains certain rights in this software.
//
// Under the terms of Contract DE-AC52-06NA25396 with Los Alamos National
// Laboratory (LANL), the U.S. Government retains certain rights in
// this software.
//============================================================================
#include <vtkm/cont/DynamicArrayHandle.h>
#include <vtkm/TypeTraits.h>
#include <vtkm/cont/ArrayHandleCast.h>
#include <vtkm/cont/ArrayHandleCompositeVector.h>
#include <vtkm/cont/ArrayHandleConstant.h>
#include <vtkm/cont/ArrayHandleCounting.h>
#include <vtkm/cont/ArrayHandleGroupVec.h>
#include <vtkm/cont/ArrayHandleImplicit.h>
#include <vtkm/cont/ArrayHandleIndex.h>
#include <vtkm/cont/ArrayHandlePermutation.h>
#include <vtkm/cont/ArrayHandleTransform.h>
#include <vtkm/cont/ArrayHandleUniformPointCoordinates.h>
#include <vtkm/cont/ArrayHandleZip.h>
#include <vtkm/cont/internal/IteratorFromArrayPortal.h>
#include <vtkm/cont/testing/Testing.h>
#include <sstream>
#include <string>
#include <typeinfo>
2017-05-18 14:29:41 +00:00
namespace vtkm
{
// DynamicArrayHandle requires its value type to have a defined VecTraits
// class. One of the tests is to use an "unusual" array of std::string
// (which is pretty pointless but might tease out some assumptions).
// Make an implementation here. Because I am lazy, this is only a partial
// implementation.
2017-05-18 14:29:41 +00:00
template <>
struct VecTraits<std::string>
{
static constexpr vtkm::IdComponent NUM_COMPONENTS = 1;
using HasMultipleComponents = vtkm::VecTraitsTagSingleComponent;
};
} // namespace vtkm
2017-05-18 14:29:41 +00:00
namespace
{
const vtkm::Id ARRAY_SIZE = 10;
2017-05-18 14:29:41 +00:00
struct TypeListTagString : vtkm::ListTagBase<std::string>
{
};
2017-05-18 14:29:41 +00:00
template <typename T>
struct UnusualPortal
{
using ValueType = T;
VTKM_EXEC_CONT
vtkm::Id GetNumberOfValues() const { return ARRAY_SIZE; }
VTKM_EXEC_CONT
2017-05-18 14:29:41 +00:00
ValueType Get(vtkm::Id index) const { return TestValue(index, ValueType()); }
};
2017-05-18 14:29:41 +00:00
template <typename T>
class ArrayHandleWithUnusualStorage
2017-05-18 14:29:41 +00:00
: public vtkm::cont::ArrayHandle<T, vtkm::cont::StorageTagImplicit<UnusualPortal<T>>>
{
using Superclass = vtkm::cont::ArrayHandle<T, vtkm::cont::StorageTagImplicit<UnusualPortal<T>>>;
2017-05-18 14:29:41 +00:00
public:
VTKM_CONT
ArrayHandleWithUnusualStorage()
2017-05-18 14:29:41 +00:00
: Superclass(typename Superclass::PortalConstControl())
{
}
};
2017-05-18 14:29:41 +00:00
struct StorageListTagUnusual
: vtkm::ListTagBase<ArrayHandleWithUnusualStorage<vtkm::Id>::StorageTag,
ArrayHandleWithUnusualStorage<std::string>::StorageTag>
{
};
2017-05-18 14:29:41 +00:00
template <typename T>
struct TestValueFunctor
{
2017-05-18 14:29:41 +00:00
T operator()(vtkm::Id index) const { return TestValue(index, T()); }
};
struct CheckFunctor
{
2017-05-18 14:29:41 +00:00
template <typename T, typename Storage>
void operator()(vtkm::cont::ArrayHandle<T, Storage> array, bool& called) const
2017-05-18 14:29:41 +00:00
{
called = true;
std::cout << " Checking for type: " << typeid(T).name() << std::endl;
2017-05-18 14:29:41 +00:00
VTKM_TEST_ASSERT(array.GetNumberOfValues() == ARRAY_SIZE, "Unexpected array size.");
2017-05-18 14:29:41 +00:00
typename vtkm::cont::ArrayHandle<T, Storage>::PortalConstControl portal =
array.GetPortalConstControl();
CheckPortal(portal);
}
};
2017-05-18 14:29:41 +00:00
template <typename TypeList, typename StorageList>
void BasicDynamicArrayChecks(const vtkm::cont::DynamicArrayHandleBase<TypeList, StorageList>& array,
vtkm::IdComponent numComponents)
{
VTKM_TEST_ASSERT(array.GetNumberOfValues() == ARRAY_SIZE,
"Dynamic array reports unexpected size.");
VTKM_TEST_ASSERT(array.GetNumberOfComponents() == numComponents,
"Dynamic array reports unexpected number of components.");
}
2017-05-18 14:29:41 +00:00
void CheckDynamicArray(vtkm::cont::DynamicArrayHandle array, vtkm::IdComponent numComponents)
{
BasicDynamicArrayChecks(array, numComponents);
bool called = false;
array.CastAndCall(CheckFunctor(), called);
2017-05-18 14:29:41 +00:00
VTKM_TEST_ASSERT(
called, "The functor was never called (and apparently a bad value exception not thrown).");
}
2017-05-18 14:29:41 +00:00
template <typename TypeList, typename StorageList>
void CheckDynamicArray(vtkm::cont::DynamicArrayHandleBase<TypeList, StorageList> array,
vtkm::IdComponent numComponents)
{
BasicDynamicArrayChecks(array, numComponents);
bool called = false;
CastAndCall(array, CheckFunctor(), called);
2017-05-18 14:29:41 +00:00
VTKM_TEST_ASSERT(
called, "The functor was never called (and apparently a bad value exception not thrown).");
}
2017-05-18 14:29:41 +00:00
template <typename T>
vtkm::cont::DynamicArrayHandle CreateDynamicArray(T)
{
// Declared static to prevent going out of scope.
static T buffer[ARRAY_SIZE];
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
{
buffer[index] = TestValue(index, T());
}
2017-05-18 14:29:41 +00:00
return vtkm::cont::DynamicArrayHandle(vtkm::cont::make_ArrayHandle(buffer, ARRAY_SIZE));
}
2017-05-18 14:29:41 +00:00
template <typename ArrayHandleType>
void CheckCastToArrayHandle(const ArrayHandleType& array)
{
VTKM_IS_ARRAY_HANDLE(ArrayHandleType);
vtkm::cont::DynamicArrayHandle dynamicArray = array;
2017-05-18 14:29:41 +00:00
VTKM_TEST_ASSERT(!dynamicArray.IsType<vtkm::cont::ArrayHandle<std::string>>(),
"Dynamic array reporting is wrong type.");
ArrayHandleType castArray1;
dynamicArray.CopyTo(castArray1);
2017-05-18 14:29:41 +00:00
VTKM_TEST_ASSERT(dynamicArray.IsSameType(castArray1), "Did not query handle correctly.");
VTKM_TEST_ASSERT(array == castArray1, "Did not get back same array.");
ArrayHandleType castArray2 =
2017-05-18 14:29:41 +00:00
dynamicArray.CastToTypeStorage<typename ArrayHandleType::ValueType,
typename ArrayHandleType::StorageTag>();
VTKM_TEST_ASSERT(array == castArray2, "Did not get back same array.");
}
2017-05-18 14:29:41 +00:00
template <typename T, typename DynamicArrayType>
void TryNewInstance(T, DynamicArrayType originalArray)
{
// This check should already have been performed by caller, but just in case.
CheckDynamicArray(originalArray, vtkm::VecTraits<T>::NUM_COMPONENTS);
std::cout << "Create new instance of array." << std::endl;
DynamicArrayType newArray = originalArray.NewInstance();
2017-05-18 14:29:41 +00:00
std::cout << "Get a static instance of the new array (which checks the type)." << std::endl;
vtkm::cont::ArrayHandle<T> staticArray;
newArray.CopyTo(staticArray);
std::cout << "Fill the new array with invalid values and make sure the original" << std::endl
<< "is uneffected." << std::endl;
staticArray.Allocate(ARRAY_SIZE);
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
{
2017-05-18 14:29:41 +00:00
staticArray.GetPortalControl().Set(index, TestValue(index + 100, T()));
}
CheckDynamicArray(originalArray, vtkm::VecTraits<T>::NUM_COMPONENTS);
std::cout << "Set the new static array to expected values and make sure the new" << std::endl
<< "dynamic array points to the same new values." << std::endl;
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
{
staticArray.GetPortalControl().Set(index, TestValue(index, T()));
}
CheckDynamicArray(newArray, vtkm::VecTraits<T>::NUM_COMPONENTS);
}
2017-05-18 14:29:41 +00:00
template <typename T>
void TryDefaultType(T)
{
vtkm::cont::DynamicArrayHandle array = CreateDynamicArray(T());
CheckDynamicArray(array, vtkm::VecTraits<T>::NUM_COMPONENTS);
TryNewInstance(T(), array);
}
struct TryBasicVTKmType
{
2017-05-18 14:29:41 +00:00
template <typename T>
void operator()(T) const
{
vtkm::cont::DynamicArrayHandle array = CreateDynamicArray(T());
CheckDynamicArray(array.ResetTypeList(vtkm::TypeListTagAll()),
vtkm::VecTraits<T>::NUM_COMPONENTS);
TryNewInstance(T(), array.ResetTypeList(vtkm::TypeListTagAll()));
}
};
void TryUnusualType()
{
// A string is an unlikely type to be declared elsewhere in VTK-m.
vtkm::cont::DynamicArrayHandle array = CreateDynamicArray(std::string());
try
{
CheckDynamicArray(array, 1);
VTKM_TEST_FAIL("CastAndCall failed to error for unrecognized type.");
}
2017-02-23 15:13:30 +00:00
catch (vtkm::cont::ErrorBadValue&)
{
std::cout << " Caught exception for unrecognized type." << std::endl;
}
CheckDynamicArray(array.ResetTypeList(TypeListTagString()), 1);
2017-05-18 14:29:41 +00:00
std::cout << " Found type when type list was reset." << std::endl;
}
void TryUnusualStorage()
{
2017-05-18 14:29:41 +00:00
vtkm::cont::DynamicArrayHandle array = ArrayHandleWithUnusualStorage<vtkm::Id>();
try
{
CheckDynamicArray(array, 1);
VTKM_TEST_FAIL("CastAndCall failed to error for unrecognized storage.");
}
2017-02-23 15:13:30 +00:00
catch (vtkm::cont::ErrorBadValue&)
{
std::cout << " Caught exception for unrecognized storage." << std::endl;
}
CheckDynamicArray(array.ResetStorageList(StorageListTagUnusual()), 1);
2017-05-18 14:29:41 +00:00
std::cout << " Found instance when storage list was reset." << std::endl;
}
void TryUnusualTypeAndStorage()
{
2017-05-18 14:29:41 +00:00
vtkm::cont::DynamicArrayHandle array = ArrayHandleWithUnusualStorage<std::string>();
try
{
CheckDynamicArray(array, 1);
2017-05-18 14:29:41 +00:00
VTKM_TEST_FAIL("CastAndCall failed to error for unrecognized type/storage.");
}
2017-02-23 15:13:30 +00:00
catch (vtkm::cont::ErrorBadValue&)
{
2017-05-18 14:29:41 +00:00
std::cout << " Caught exception for unrecognized type/storage." << std::endl;
}
try
{
CheckDynamicArray(array.ResetTypeList(TypeListTagString()), 1);
VTKM_TEST_FAIL("CastAndCall failed to error for unrecognized storage.");
}
2017-02-23 15:13:30 +00:00
catch (vtkm::cont::ErrorBadValue&)
{
std::cout << " Caught exception for unrecognized storage." << std::endl;
}
try
{
CheckDynamicArray(array.ResetStorageList(StorageListTagUnusual()), 1);
VTKM_TEST_FAIL("CastAndCall failed to error for unrecognized type.");
}
2017-02-23 15:13:30 +00:00
catch (vtkm::cont::ErrorBadValue&)
{
std::cout << " Caught exception for unrecognized type." << std::endl;
}
try
{
//resetting the string and tag should result in a valid array handle
2017-05-18 14:29:41 +00:00
CheckDynamicArray(array.ResetTypeAndStorageLists(TypeListTagString(), StorageListTagUnusual()),
1);
}
2017-02-23 15:13:30 +00:00
catch (vtkm::cont::ErrorBadValue&)
{
VTKM_TEST_FAIL("ResetTypeAndStorageLists should have handled the custom type/storage.");
}
2017-05-18 14:29:41 +00:00
CheckDynamicArray(
array.ResetTypeList(TypeListTagString()).ResetStorageList(StorageListTagUnusual()), 1);
std::cout << " Found instance when type and storage lists were reset." << std::endl;
2017-05-18 14:29:41 +00:00
CheckDynamicArray(
array.ResetStorageList(StorageListTagUnusual()).ResetTypeList(TypeListTagString()), 1);
std::cout << " Found instance when storage and type lists were reset." << std::endl;
2017-05-18 14:29:41 +00:00
CheckDynamicArray(array.ResetTypeAndStorageLists(TypeListTagString(), StorageListTagUnusual()),
1);
2017-05-18 14:29:41 +00:00
std::cout << " Found instance when storage and type lists were reset." << std::endl;
}
void TryCastToArrayHandle()
{
std::cout << " Normal array handle." << std::endl;
vtkm::Id buffer[ARRAY_SIZE];
for (vtkm::Id index = 0; index < ARRAY_SIZE; index++)
{
buffer[index] = TestValue(index, vtkm::Id());
}
2017-05-18 14:29:41 +00:00
vtkm::cont::ArrayHandle<vtkm::Id> array = vtkm::cont::make_ArrayHandle(buffer, ARRAY_SIZE);
CheckCastToArrayHandle(array);
std::cout << " Cast array handle." << std::endl;
2017-05-18 14:29:41 +00:00
CheckCastToArrayHandle(vtkm::cont::make_ArrayHandleCast(array, vtkm::FloatDefault()));
std::cout << " Composite vector array handle." << std::endl;
CheckCastToArrayHandle(vtkm::cont::make_ArrayHandleCompositeVector(array, array));
std::cout << " Constant array handle." << std::endl;
CheckCastToArrayHandle(vtkm::cont::make_ArrayHandleConstant(5, ARRAY_SIZE));
std::cout << " Counting array handle." << std::endl;
2017-05-18 14:29:41 +00:00
vtkm::cont::ArrayHandleCounting<vtkm::Id> countingArray(ARRAY_SIZE - 1, -1, ARRAY_SIZE);
CheckCastToArrayHandle(countingArray);
std::cout << " Group vec array handle" << std::endl;
2017-05-18 14:29:41 +00:00
vtkm::cont::ArrayHandleGroupVec<vtkm::cont::ArrayHandle<vtkm::Id>, 2> groupVecArray(array);
CheckCastToArrayHandle(groupVecArray);
std::cout << " Implicit array handle." << std::endl;
2017-05-30 15:13:18 +00:00
CheckCastToArrayHandle(
vtkm::cont::make_ArrayHandleImplicit(TestValueFunctor<vtkm::FloatDefault>(), ARRAY_SIZE));
std::cout << " Index array handle." << std::endl;
CheckCastToArrayHandle(vtkm::cont::ArrayHandleIndex(ARRAY_SIZE));
std::cout << " Permutation array handle." << std::endl;
2017-05-18 14:29:41 +00:00
CheckCastToArrayHandle(vtkm::cont::make_ArrayHandlePermutation(countingArray, array));
std::cout << " Transform array handle." << std::endl;
2017-05-30 14:00:01 +00:00
CheckCastToArrayHandle(
vtkm::cont::make_ArrayHandleTransform(countingArray, TestValueFunctor<vtkm::FloatDefault>()));
std::cout << " Uniform point coordinates array handle." << std::endl;
2017-05-18 14:29:41 +00:00
CheckCastToArrayHandle(vtkm::cont::ArrayHandleUniformPointCoordinates(vtkm::Id3(ARRAY_SIZE)));
std::cout << " Zip array handle." << std::endl;
CheckCastToArrayHandle(vtkm::cont::make_ArrayHandleZip(countingArray, array));
}
void TestDynamicArrayHandle()
{
std::cout << "Try common types with default type lists." << std::endl;
std::cout << "*** vtkm::Id **********************" << std::endl;
TryDefaultType(vtkm::Id());
std::cout << "*** vtkm::FloatDefault ************" << std::endl;
TryDefaultType(vtkm::FloatDefault());
std::cout << "*** vtkm::Float32 *****************" << std::endl;
TryDefaultType(vtkm::Float32());
std::cout << "*** vtkm::Float64 *****************" << std::endl;
TryDefaultType(vtkm::Float64());
std::cout << "*** vtkm::Vec<Float32,3> **********" << std::endl;
2017-05-18 14:29:41 +00:00
TryDefaultType(vtkm::Vec<vtkm::Float32, 3>());
std::cout << "*** vtkm::Vec<Float64,3> **********" << std::endl;
2017-05-18 14:29:41 +00:00
TryDefaultType(vtkm::Vec<vtkm::Float64, 3>());
std::cout << "Try exemplar VTK-m types." << std::endl;
vtkm::testing::Testing::TryTypes(TryBasicVTKmType());
std::cout << "Try unusual type." << std::endl;
TryUnusualType();
std::cout << "Try unusual storage." << std::endl;
TryUnusualStorage();
std::cout << "Try unusual type in unusual storage." << std::endl;
TryUnusualTypeAndStorage();
std::cout << "Try CastToArrayHandle" << std::endl;
TryCastToArrayHandle();
}
} // anonymous namespace
2017-05-18 14:29:41 +00:00
int UnitTestDynamicArrayHandle(int, char* [])
{
return vtkm::cont::testing::Testing::Run(TestDynamicArrayHandle);
}