mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-08 21:33:55 +00:00
2a41428fe4
This allows you to easily compute the range of any ArrayHandle, even if you don't know the type. A unit test for ArrayRangeCompute was also added.
228 lines
10 KiB
C++
228 lines
10 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.
|
|
//============================================================================
|
|
#ifndef vtk_m_cont_ArrayRangeCompute_h
|
|
#define vtk_m_cont_ArrayRangeCompute_h
|
|
|
|
#include <vtkm/Range.h>
|
|
#include <vtkm/VecTraits.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/ArrayHandleCartesianProduct.h>
|
|
#include <vtkm/cont/ArrayHandleCompositeVector.h>
|
|
#include <vtkm/cont/ArrayHandleConstant.h>
|
|
#include <vtkm/cont/ArrayHandleCounting.h>
|
|
#include <vtkm/cont/ArrayHandleIndex.h>
|
|
#include <vtkm/cont/ArrayHandleSOA.h>
|
|
#include <vtkm/cont/ArrayHandleStride.h>
|
|
#include <vtkm/cont/ArrayHandleUniformPointCoordinates.h>
|
|
#include <vtkm/cont/ArrayHandleXGCCoordinates.h>
|
|
#include <vtkm/cont/DeviceAdapterTag.h>
|
|
#include <vtkm/cont/UnknownArrayHandle.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
///@{
|
|
/// \brief Compute the range of the data in an array handle.
|
|
///
|
|
/// Given an `ArrayHandle`, this function computes the range (min and max) of
|
|
/// the values in the array. For arrays containing Vec values, the range is
|
|
/// computed for each component.
|
|
///
|
|
/// This method optionally takes a `vtkm::cont::DeviceAdapterId` to control which
|
|
/// devices to try.
|
|
///
|
|
/// The result is returned in an `ArrayHandle` of `Range` objects. There is
|
|
/// one value in the returned array for every component of the input's value
|
|
/// type.
|
|
///
|
|
/// Note that the ArrayRangeCompute.h header file contains only precompiled overloads
|
|
/// of ArrayRangeCompute. This is so that ArrayRangeCompute.h can be included in
|
|
/// code that does not use a device compiler. If you need to compute array ranges
|
|
/// for arbitrary `ArrayHandle`s not in this precompiled list, you need to include
|
|
/// ArrayRangeComputeTemplate.h. This contains a templated version of ArrayRangeCompute
|
|
/// that will compile for any `ArrayHandle` type not already handled.
|
|
///
|
|
|
|
VTKM_CONT_EXPORT vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute(
|
|
const vtkm::cont::UnknownArrayHandle& array,
|
|
vtkm::cont::DeviceAdapterId device = vtkm::cont::DeviceAdapterTagAny{});
|
|
|
|
#define VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(T, Storage) \
|
|
VTKM_CONT_EXPORT \
|
|
VTKM_CONT \
|
|
vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute( \
|
|
const vtkm::cont::ArrayHandle<T, Storage>& input, \
|
|
vtkm::cont::DeviceAdapterId device = vtkm::cont::DeviceAdapterTagAny())
|
|
#define VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(T, N, Storage) \
|
|
VTKM_CONT_EXPORT \
|
|
VTKM_CONT \
|
|
vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute( \
|
|
const vtkm::cont::ArrayHandle<vtkm::Vec<T, N>, Storage>& input, \
|
|
vtkm::cont::DeviceAdapterId device = vtkm::cont::DeviceAdapterTagAny())
|
|
|
|
#define VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_SCALAR_T(Storage) \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::Int8, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::UInt8, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::Int16, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::UInt16, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::Int32, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::UInt32, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::Int64, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::UInt64, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::Float32, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(vtkm::Float64, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(char, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(signed VTKM_UNUSED_INT_TYPE, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T(unsigned VTKM_UNUSED_INT_TYPE, Storage)
|
|
|
|
#define VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(N, Storage) \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Int8, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::UInt8, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Int16, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::UInt16, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Int32, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::UInt32, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Int64, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::UInt64, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Float32, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Float64, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(char, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(signed VTKM_UNUSED_INT_TYPE, N, Storage); \
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(unsigned VTKM_UNUSED_INT_TYPE, N, Storage)
|
|
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_SCALAR_T(vtkm::cont::StorageTagBasic);
|
|
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(2, vtkm::cont::StorageTagBasic);
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(3, vtkm::cont::StorageTagBasic);
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(4, vtkm::cont::StorageTagBasic);
|
|
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(2, vtkm::cont::StorageTagSOA);
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(3, vtkm::cont::StorageTagSOA);
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC(4, vtkm::cont::StorageTagSOA);
|
|
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_SCALAR_T(vtkm::cont::StorageTagStride);
|
|
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Float32, 3, vtkm::cont::StorageTagXGCCoordinates);
|
|
VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC(vtkm::Float64, 3, vtkm::cont::StorageTagXGCCoordinates);
|
|
|
|
#undef VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_T
|
|
#undef VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_VEC
|
|
#undef VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_SCALAR_T
|
|
#undef VTK_M_ARRAY_RANGE_COMPUTE_EXPORT_ALL_VEC
|
|
|
|
VTKM_CONT_EXPORT VTKM_CONT vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute(
|
|
const vtkm::cont::ArrayHandle<vtkm::Vec3f,
|
|
vtkm::cont::ArrayHandleUniformPointCoordinates::StorageTag>& array,
|
|
vtkm::cont::DeviceAdapterId device = vtkm::cont::DeviceAdapterTagAny());
|
|
|
|
// Implementation of cartesian products
|
|
template <typename T, typename ST1, typename ST2, typename ST3>
|
|
VTKM_CONT inline vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute(
|
|
const vtkm::cont::ArrayHandle<vtkm::Vec<T, 3>,
|
|
vtkm::cont::StorageTagCartesianProduct<ST1, ST2, ST3>>& input_,
|
|
vtkm::cont::DeviceAdapterId device = vtkm::cont::DeviceAdapterTagAny())
|
|
{
|
|
vtkm::cont::ArrayHandle<vtkm::Range> result;
|
|
result.Allocate(3);
|
|
|
|
vtkm::cont::ArrayHandle<vtkm::Range> componentRangeArray;
|
|
vtkm::Range componentRange;
|
|
|
|
vtkm::cont::ArrayHandleCartesianProduct<vtkm::cont::ArrayHandle<T, ST1>,
|
|
vtkm::cont::ArrayHandle<T, ST2>,
|
|
vtkm::cont::ArrayHandle<T, ST3>>
|
|
input = input_;
|
|
vtkm::cont::ArrayHandle<T, ST1> firstArray = input.GetFirstArray();
|
|
componentRangeArray = vtkm::cont::ArrayRangeCompute(firstArray, device);
|
|
componentRange = componentRangeArray.ReadPortal().Get(0);
|
|
result.WritePortal().Set(0, componentRange);
|
|
|
|
vtkm::cont::ArrayHandle<T, ST2> secondArray = input.GetSecondArray();
|
|
componentRangeArray = vtkm::cont::ArrayRangeCompute(secondArray, device);
|
|
componentRange = componentRangeArray.ReadPortal().Get(0);
|
|
result.WritePortal().Set(1, componentRange);
|
|
|
|
vtkm::cont::ArrayHandle<T, ST3> thirdArray = input.GetThirdArray();
|
|
componentRangeArray = vtkm::cont::ArrayRangeCompute(thirdArray, device);
|
|
componentRange = componentRangeArray.ReadPortal().Get(0);
|
|
result.WritePortal().Set(2, componentRange);
|
|
|
|
return result;
|
|
}
|
|
|
|
// Implementation of constant arrays
|
|
template <typename T>
|
|
VTKM_CONT inline vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute(
|
|
const vtkm::cont::ArrayHandle<T, vtkm::cont::StorageTagConstant>& input,
|
|
vtkm::cont::DeviceAdapterId vtkmNotUsed(device) = vtkm::cont::DeviceAdapterTagAny{})
|
|
{
|
|
using Traits = vtkm::VecTraits<T>;
|
|
const T value = vtkm::cont::ArrayHandleConstant<T>(input).GetValue();
|
|
vtkm::IdComponent numComponents = Traits::GetNumberOfComponents(value);
|
|
vtkm::cont::ArrayHandle<vtkm::Range> result;
|
|
result.Allocate(numComponents);
|
|
auto portal = result.WritePortal();
|
|
for (vtkm::IdComponent cIndex = 0; cIndex < numComponents; ++cIndex)
|
|
{
|
|
auto component = Traits::GetComponent(value, cIndex);
|
|
portal.Set(cIndex, vtkm::Range(component, component));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
// Implementation of counting arrays
|
|
template <typename T>
|
|
VTKM_CONT inline vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute(
|
|
const vtkm::cont::ArrayHandle<T, vtkm::cont::StorageTagCounting>& input,
|
|
vtkm::cont::DeviceAdapterId vtkmNotUsed(device) = vtkm::cont::DeviceAdapterTagAny{})
|
|
{
|
|
using Traits = vtkm::VecTraits<T>;
|
|
vtkm::cont::ArrayHandle<vtkm::Range> result;
|
|
result.Allocate(Traits::NUM_COMPONENTS);
|
|
auto portal = result.WritePortal();
|
|
if (portal.GetNumberOfValues() > 0)
|
|
{
|
|
T first = input.ReadPortal().Get(0);
|
|
T last = input.ReadPortal().Get(input.GetNumberOfValues() - 1);
|
|
for (vtkm::IdComponent cIndex = 0; cIndex < Traits::NUM_COMPONENTS; ++cIndex)
|
|
{
|
|
auto firstComponent = Traits::GetComponent(first, cIndex);
|
|
auto lastComponent = Traits::GetComponent(last, cIndex);
|
|
portal.Set(cIndex,
|
|
vtkm::Range(vtkm::Min(firstComponent, lastComponent),
|
|
vtkm::Max(firstComponent, lastComponent)));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Array is empty
|
|
for (vtkm::IdComponent cIndex = 0; cIndex < Traits::NUM_COMPONENTS; ++cIndex)
|
|
{
|
|
portal.Set(cIndex, vtkm::Range{});
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
// Implementation of index arrays
|
|
VTKM_CONT_EXPORT vtkm::cont::ArrayHandle<vtkm::Range> ArrayRangeCompute(
|
|
const vtkm::cont::ArrayHandle<vtkm::Id, vtkm::cont::StorageTagIndex>& input,
|
|
vtkm::cont::DeviceAdapterId device = vtkm::cont::DeviceAdapterTagAny{});
|
|
///@}
|
|
|
|
VTKM_CONT_EXPORT void ThrowArrayRangeComputeFailed();
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif //vtk_m_cont_ArrayRangeCompute_h
|