mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
Add VecVariable
This class holds a Vec and exposes some number of components. The class is used when you need a Vec of a size that is not known at compile time but that a maximum length of reasonable size is known.
This commit is contained in:
parent
c847f0b148
commit
da2e601b6a
@ -35,6 +35,7 @@ set(headers
|
|||||||
TypeTraits.h
|
TypeTraits.h
|
||||||
VectorAnalysis.h
|
VectorAnalysis.h
|
||||||
VecTraits.h
|
VecTraits.h
|
||||||
|
VecVariable.h
|
||||||
UnaryPredicates.h
|
UnaryPredicates.h
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -557,6 +557,12 @@ public:
|
|||||||
typedef T ComponentType;
|
typedef T ComponentType;
|
||||||
static const vtkm::IdComponent NUM_COMPONENTS = NumRow*NumCol;
|
static const vtkm::IdComponent NUM_COMPONENTS = NumRow*NumCol;
|
||||||
typedef vtkm::VecTraitsTagMultipleComponents HasMultipleComponents;
|
typedef vtkm::VecTraitsTagMultipleComponents HasMultipleComponents;
|
||||||
|
typedef vtkm::VecTraitsTagSizeStatic IsSizeStatic;
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static vtkm::IdComponent GetNumberOfComponents(const MatrixType &) {
|
||||||
|
return NUM_COMPONENTS;
|
||||||
|
}
|
||||||
|
|
||||||
VTKM_EXEC_CONT_EXPORT
|
VTKM_EXEC_CONT_EXPORT
|
||||||
static const ComponentType &GetComponent(const MatrixType &matrix,
|
static const ComponentType &GetComponent(const MatrixType &matrix,
|
||||||
|
@ -146,6 +146,7 @@ struct VecTraits<vtkm::Vec<T,Size> >
|
|||||||
|
|
||||||
/// Number of components in the given vector.
|
/// Number of components in the given vector.
|
||||||
///
|
///
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
static vtkm::IdComponent GetNumberOfComponents(const VecType &) {
|
static vtkm::IdComponent GetNumberOfComponents(const VecType &) {
|
||||||
return NUM_COMPONENTS;
|
return NUM_COMPONENTS;
|
||||||
}
|
}
|
||||||
|
167
vtkm/VecVariable.h
Normal file
167
vtkm/VecVariable.h
Normal file
@ -0,0 +1,167 @@
|
|||||||
|
//============================================================================
|
||||||
|
// 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 2015 Sandia Corporation.
|
||||||
|
// Copyright 2015 UT-Battelle, LLC.
|
||||||
|
// Copyright 2015 Los Alamos National Security.
|
||||||
|
//
|
||||||
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
||||||
|
// 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.
|
||||||
|
//============================================================================
|
||||||
|
#ifndef vtk_m_VecVariable_h
|
||||||
|
#define vtk_m_VecVariable_h
|
||||||
|
|
||||||
|
#include <vtkm/Math.h>
|
||||||
|
#include <vtkm/Types.h>
|
||||||
|
#include <vtkm/TypeTraits.h>
|
||||||
|
#include <vtkm/VecTraits.h>
|
||||||
|
|
||||||
|
namespace vtkm {
|
||||||
|
|
||||||
|
/// \brief A short variable-length array with maximum length.
|
||||||
|
///
|
||||||
|
/// The \c VecVariable class is a Vec-like class that holds a short array of
|
||||||
|
/// some maximum length. To avoid dynamic allocations, the maximum length is
|
||||||
|
/// specified at compile time. Internally, \c VecVariable holds a \c Vec of
|
||||||
|
/// the maximum length and exposes a subsection of it.
|
||||||
|
///
|
||||||
|
template<typename T, vtkm::IdComponent MaxSize>
|
||||||
|
class VecVariable
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
typedef T ComponentType;
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
VecVariable() : NumComponents(0) { }
|
||||||
|
|
||||||
|
template<vtkm::IdComponent SrcSize>
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
VecVariable(const vtkm::VecVariable<ComponentType,SrcSize> &src)
|
||||||
|
: NumComponents(src.GetNumberOfComponents())
|
||||||
|
{
|
||||||
|
for (vtkm::IdComponent index = 0; index < this->NumComponents; index++)
|
||||||
|
{
|
||||||
|
this->Data[index] = src[index];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template<vtkm::IdComponent SrcSize>
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
VecVariable(const vtkm::Vec<ComponentType,SrcSize> &src)
|
||||||
|
: NumComponents(SrcSize)
|
||||||
|
{
|
||||||
|
for (vtkm::IdComponent index = 0; index < this->NumComponents; index++)
|
||||||
|
{
|
||||||
|
this->Data[index] = src[index];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
vtkm::IdComponent GetNumberOfComponents() const {
|
||||||
|
return this->NumComponents;
|
||||||
|
}
|
||||||
|
|
||||||
|
template<vtkm::IdComponent DestSize>
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
void CopyInto(vtkm::Vec<ComponentType,DestSize> &dest) const
|
||||||
|
{
|
||||||
|
vtkm::IdComponent numComponents = vtkm::Min(DestSize, this->NumComponents);
|
||||||
|
for (vtkm::IdComponent index = 0; index < numComponents; index++)
|
||||||
|
{
|
||||||
|
dest[index] = this->Data[index];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
const ComponentType &operator[](vtkm::IdComponent index) const
|
||||||
|
{
|
||||||
|
return this->Data[index];
|
||||||
|
}
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
ComponentType &operator[](vtkm::IdComponent index)
|
||||||
|
{
|
||||||
|
return this->Data[index];
|
||||||
|
}
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
void Append(ComponentType value)
|
||||||
|
{
|
||||||
|
this->Data[this->NumComponents] = value;
|
||||||
|
this->NumComponents++;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
vtkm::Vec<T,MaxSize> Data;
|
||||||
|
vtkm::IdComponent NumComponents;
|
||||||
|
};
|
||||||
|
|
||||||
|
template<typename T, vtkm::IdComponent MaxSize>
|
||||||
|
struct TypeTraits<vtkm::VecVariable<T,MaxSize> >
|
||||||
|
{
|
||||||
|
typedef typename vtkm::TypeTraits<T>::NumericTag NumericTag;
|
||||||
|
typedef TypeTraitsVectorTag DimensionalityTag;
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static vtkm::VecVariable<T,MaxSize> ZeroInitialization()
|
||||||
|
{
|
||||||
|
return vtkm::VecVariable<T,MaxSize>();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template<typename T, vtkm::IdComponent MaxSize>
|
||||||
|
struct VecTraits<vtkm::VecVariable<T,MaxSize> >
|
||||||
|
{
|
||||||
|
typedef vtkm::VecVariable<T,MaxSize> VecType;
|
||||||
|
|
||||||
|
typedef typename VecType::ComponentType ComponentType;
|
||||||
|
typedef vtkm::VecTraitsTagMultipleComponents HasMultipleComponents;
|
||||||
|
typedef vtkm::VecTraitsTagSizeVariable IsSizeStatic;
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static vtkm::IdComponent GetNumberOfComponents(const VecType &vector) {
|
||||||
|
return vector.GetNumberOfComponents();
|
||||||
|
}
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static const ComponentType &GetComponent(const VecType &vector,
|
||||||
|
vtkm::IdComponent componentIndex)
|
||||||
|
{
|
||||||
|
return vector[componentIndex];
|
||||||
|
}
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static ComponentType &GetComponent(VecType &vector,
|
||||||
|
vtkm::IdComponent componentIndex)
|
||||||
|
{
|
||||||
|
return vector[componentIndex];
|
||||||
|
}
|
||||||
|
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static void SetComponent(VecType &vector,
|
||||||
|
vtkm::IdComponent componentIndex,
|
||||||
|
const ComponentType &value)
|
||||||
|
{
|
||||||
|
vector[componentIndex] = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
template<vtkm::IdComponent destSize>
|
||||||
|
VTKM_EXEC_CONT_EXPORT
|
||||||
|
static void CopyInto(const VecType &src,
|
||||||
|
vtkm::Vec<ComponentType,destSize> &dest)
|
||||||
|
{
|
||||||
|
src.CopyInto(dest);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace vtkm
|
||||||
|
|
||||||
|
#endif //vtk_m_VecVariable_h
|
@ -42,6 +42,7 @@ set(unit_tests
|
|||||||
UnitTestUnaryPredicates.cxx
|
UnitTestUnaryPredicates.cxx
|
||||||
UnitTestVectorAnalysis.cxx
|
UnitTestVectorAnalysis.cxx
|
||||||
UnitTestVecTraits.cxx
|
UnitTestVecTraits.cxx
|
||||||
|
UnitTestVecVariable.cxx
|
||||||
)
|
)
|
||||||
|
|
||||||
VTKM_unit_tests(SOURCES ${unit_tests})
|
VTKM_unit_tests(SOURCES ${unit_tests})
|
||||||
|
@ -277,10 +277,15 @@ bool test_equal(VectorType1 vector1,
|
|||||||
{
|
{
|
||||||
typedef typename vtkm::VecTraits<VectorType1> Traits1;
|
typedef typename vtkm::VecTraits<VectorType1> Traits1;
|
||||||
typedef typename vtkm::VecTraits<VectorType2> Traits2;
|
typedef typename vtkm::VecTraits<VectorType2> Traits2;
|
||||||
BOOST_STATIC_ASSERT(Traits1::NUM_COMPONENTS == Traits2::NUM_COMPONENTS);
|
|
||||||
|
if (Traits1::GetNumberOfComponents(vector1) !=
|
||||||
|
Traits2::GetNumberOfComponents(vector2))
|
||||||
|
{
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
for (vtkm::IdComponent component = 0;
|
for (vtkm::IdComponent component = 0;
|
||||||
component < Traits1::NUM_COMPONENTS;
|
component < Traits1::GetNumberOfComponents(vector1);
|
||||||
component++)
|
component++)
|
||||||
{
|
{
|
||||||
vtkm::Float64 value1 =
|
vtkm::Float64 value1 =
|
||||||
|
@ -18,26 +18,6 @@
|
|||||||
// this software.
|
// this software.
|
||||||
//============================================================================
|
//============================================================================
|
||||||
|
|
||||||
//============================================================================
|
|
||||||
// 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 Sandia Corporation.
|
|
||||||
// Copyright 2014 UT-Battelle, LLC.
|
|
||||||
// Copyright 2014 Los Alamos National Security.
|
|
||||||
//
|
|
||||||
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
|
||||||
// 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/Types.h>
|
#include <vtkm/Types.h>
|
||||||
|
|
||||||
#include <vtkm/testing/Testing.h>
|
#include <vtkm/testing/Testing.h>
|
||||||
|
117
vtkm/testing/UnitTestVecVariable.cxx
Normal file
117
vtkm/testing/UnitTestVecVariable.cxx
Normal file
@ -0,0 +1,117 @@
|
|||||||
|
//============================================================================
|
||||||
|
// 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 2015 Sandia Corporation.
|
||||||
|
// Copyright 2015 UT-Battelle, LLC.
|
||||||
|
// Copyright 2015 Los Alamos National Security.
|
||||||
|
//
|
||||||
|
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
|
||||||
|
// 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/VecVariable.h>
|
||||||
|
|
||||||
|
#include <vtkm/testing/Testing.h>
|
||||||
|
|
||||||
|
namespace {
|
||||||
|
|
||||||
|
struct VecVariableTestFunctor
|
||||||
|
{
|
||||||
|
// You will get a compile fail if this does not pass
|
||||||
|
template<typename NumericTag>
|
||||||
|
void CheckNumericTag(NumericTag, NumericTag) const
|
||||||
|
{
|
||||||
|
std::cout << "NumericTag pass" << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// You will get a compile fail if this does not pass
|
||||||
|
void CheckDimensionalityTag(vtkm::TypeTraitsVectorTag) const
|
||||||
|
{
|
||||||
|
std::cout << "VectorTag pass" << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// You will get a compile fail if this does not pass
|
||||||
|
template<typename T>
|
||||||
|
void CheckComponentType(T, T) const
|
||||||
|
{
|
||||||
|
std::cout << "ComponentType pass" << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// You will get a compile fail if this does not pass
|
||||||
|
void CheckHasMultipleComponents(vtkm::VecTraitsTagMultipleComponents) const
|
||||||
|
{
|
||||||
|
std::cout << "MultipleComponents pass" << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// You will get a compile fail if this does not pass
|
||||||
|
void CheckVariableSize(vtkm::VecTraitsTagSizeVariable) const
|
||||||
|
{
|
||||||
|
std::cout << "VariableSize" << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
template<typename T>
|
||||||
|
void operator()(T) const
|
||||||
|
{
|
||||||
|
static const vtkm::IdComponent SIZE = 5;
|
||||||
|
typedef vtkm::Vec<T,SIZE> VecType;
|
||||||
|
typedef vtkm::VecVariable<T,SIZE> VecVariableType;
|
||||||
|
typedef vtkm::TypeTraits<VecVariableType> TTraits;
|
||||||
|
typedef vtkm::VecTraits<VecVariableType> VTraits;
|
||||||
|
|
||||||
|
std::cout << "Check NumericTag." << std::endl;
|
||||||
|
this->CheckNumericTag(typename TTraits::NumericTag(),
|
||||||
|
typename vtkm::TypeTraits<T>::NumericTag());
|
||||||
|
|
||||||
|
std::cout << "Check DimensionalityTag." << std::endl;
|
||||||
|
this->CheckDimensionalityTag(typename TTraits::DimensionalityTag());
|
||||||
|
|
||||||
|
std::cout << "Check ComponentType." << std::endl;
|
||||||
|
this->CheckComponentType(typename VTraits::ComponentType(), T());
|
||||||
|
|
||||||
|
std::cout << "Check MultipleComponents." << std::endl;
|
||||||
|
this->CheckHasMultipleComponents(typename VTraits::HasMultipleComponents());
|
||||||
|
|
||||||
|
std::cout << "Check VariableSize." << std::endl;
|
||||||
|
this->CheckVariableSize(typename VTraits::IsSizeStatic());
|
||||||
|
|
||||||
|
VecType source = TestValue(0, VecType());
|
||||||
|
|
||||||
|
VecVariableType vec1(source);
|
||||||
|
VecType vecCopy;
|
||||||
|
vec1.CopyInto(vecCopy);
|
||||||
|
VTKM_TEST_ASSERT(test_equal(vec1, vecCopy),
|
||||||
|
"Bad init or copyinto.");
|
||||||
|
|
||||||
|
vtkm::VecVariable<T,SIZE+1> vec2;
|
||||||
|
for (vtkm::IdComponent setIndex = 0; setIndex < SIZE; setIndex++)
|
||||||
|
{
|
||||||
|
VTKM_TEST_ASSERT(vec2.GetNumberOfComponents() == setIndex,
|
||||||
|
"Report wrong number of components");
|
||||||
|
vec2.Append(source[setIndex]);
|
||||||
|
}
|
||||||
|
VTKM_TEST_ASSERT(test_equal(vec2, vec1),
|
||||||
|
"Bad values from Append.");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
void TestVecVariable()
|
||||||
|
{
|
||||||
|
vtkm::testing::Testing::TryTypes(VecVariableTestFunctor(),
|
||||||
|
vtkm::TypeListTagFieldScalar());
|
||||||
|
}
|
||||||
|
|
||||||
|
} // anonymous namespace
|
||||||
|
|
||||||
|
int UnitTestVecVariable(int, char *[])
|
||||||
|
{
|
||||||
|
return vtkm::testing::Testing::Run(TestVecVariable);
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user