Added VecFromPortalPermute class.

vtkm/exec/internal/CMakeLists.txt

@@ -21,6 +21,7 @@
 set(headers
   ErrorMessageBuffer.h
   VecFromPortal.h
+  VecFromPortalPermute.h
   WorkletInvokeFunctor.h
   WorkletInvokeFunctorDetail.h
   )

vtkm/exec/internal/VecFromPortal.h

@@ -55,7 +55,7 @@ public:
   }
 
   template<vtkm::IdComponent DestSize>
-  VTKM_EXEC_CONT_EXPORT
+  VTKM_EXEC_EXPORT
   void CopyInto(vtkm::Vec<ComponentType,DestSize> &dest) const
   {
     vtkm::IdComponent numComponents = vtkm::Min(DestSize, this->NumComponents);

vtkm/exec/internal/VecFromPortalPermute.h

@@ -0,0 +1,142 @@
+//============================================================================
+//  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_exec_internal_VecFromPortalPermute_h
+#define vtk_m_exec_internal_VecFromPortalPermute_h
+
+#include <vtkm/Math.h>
+#include <vtkm/Types.h>
+#include <vtkm/TypeTraits.h>
+#include <vtkm/VecTraits.h>
+
+namespace vtkm {
+namespace exec {
+namespace internal {
+
+/// \brief A short vector from an ArrayPortal and a vector of indices.
+///
+/// The \c VecFromPortalPermute class is a Vec-like class that holds an array
+/// portal and a second Vec-like containing indices into the array. Each value
+/// of this vector is the value from the array with the respective index.
+///
+template<typename IndexVecType, typename PortalType>
+class VecFromPortalPermute
+{
+public:
+  typedef typename PortalType::ValueType ComponentType;
+
+  VTKM_EXEC_EXPORT
+  VecFromPortalPermute() {  }
+
+  VTKM_EXEC_EXPORT
+  VecFromPortalPermute(const IndexVecType &indices, const PortalType &portal)
+    : Indices(indices), Portal(portal) {  }
+
+  VTKM_EXEC_EXPORT
+  vtkm::IdComponent GetNumberOfComponents() const {
+    return this->Indices.GetNumberOfComponents();
+  }
+
+  template<vtkm::IdComponent DestSize>
+  VTKM_EXEC_EXPORT
+  void CopyInto(vtkm::Vec<ComponentType,DestSize> &dest) const
+  {
+    vtkm::IdComponent numComponents =
+        vtkm::Min(DestSize, this->GetNumberOfComponents());
+    for (vtkm::IdComponent index = 0; index < numComponents; index++)
+    {
+      dest[index] = this->Portal.Get(this->Indices[index]);
+    }
+  }
+
+  VTKM_EXEC_EXPORT
+  ComponentType operator[](vtkm::IdComponent index) const
+  {
+    return this->Portal.Get(this->Indices[index]);
+  }
+
+private:
+  IndexVecType Indices;
+  PortalType Portal;
+};
+
+}
+}
+} // namespace vtkm::exec::internal
+
+// Implementations of traits classes, which by definition are in the vtkm
+// namespace.
+
+namespace vtkm {
+
+template<typename IndexVecType, typename PortalType>
+struct TypeTraits<
+    vtkm::exec::internal::VecFromPortalPermute<IndexVecType,PortalType> >
+{
+private:
+  typedef vtkm::exec::internal::VecFromPortalPermute<IndexVecType,PortalType>
+      VecType;
+  typedef typename PortalType::ValueType ComponentType;
+
+public:
+  typedef typename vtkm::TypeTraits<ComponentType>::NumericTag NumericTag;
+  typedef TypeTraitsVectorTag DimensionalityTag;
+
+  VTKM_EXEC_EXPORT
+  static VecType ZeroInitialization()
+  {
+    return VecType();
+  }
+};
+
+template<typename IndexVecType, typename PortalType>
+struct VecTraits<
+    vtkm::exec::internal::VecFromPortalPermute<IndexVecType,PortalType> >
+{
+  typedef vtkm::exec::internal::VecFromPortalPermute<IndexVecType,PortalType>
+      VecType;
+
+  typedef typename VecType::ComponentType ComponentType;
+  typedef vtkm::VecTraitsTagMultipleComponents HasMultipleComponents;
+  typedef vtkm::VecTraitsTagSizeVariable IsSizeStatic;
+
+  VTKM_EXEC_EXPORT
+  static vtkm::IdComponent GetNumberOfComponents(const VecType &vector) {
+    return vector.GetNumberOfComponents();
+  }
+
+  VTKM_EXEC_EXPORT
+  static ComponentType GetComponent(const VecType &vector,
+                                    vtkm::IdComponent componentIndex)
+  {
+    return vector[componentIndex];
+  }
+
+  template<vtkm::IdComponent destSize>
+  VTKM_EXEC_EXPORT
+  static void CopyInto(const VecType &src,
+                       vtkm::Vec<ComponentType,destSize> &dest)
+  {
+    src.CopyInto(dest);
+  }
+};
+
+} // namespace vtkm
+
+#endif //vtk_m_exec_internal_VecFromPortalPermute_h

vtkm/exec/internal/testing/CMakeLists.txt

@@ -23,6 +23,7 @@
 set(unit_tests
   UnitTestErrorMessageBuffer.cxx
   UnitTestVecFromPortal.cxx
+  UnitTestVecFromPortalPermute.cxx
   UnitTestWorkletInvokeFunctor.cxx
   )
 vtkm_unit_tests(SOURCES ${unit_tests})

vtkm/exec/internal/testing/UnitTestVecFromPortalPermute.cxx

@@ -0,0 +1,131 @@
+//============================================================================
+//  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/exec/internal/VecFromPortalPermute.h>
+
+#include <vtkm/VecVariable.h>
+
+#include <vtkm/testing/Testing.h>
+
+namespace {
+
+static const vtkm::IdComponent ARRAY_SIZE = 10;
+
+template<typename T>
+void CheckType(T, T)
+{
+  // Check passes if this function is called correctly.
+}
+
+template<typename T>
+class TestPortal
+{
+public:
+  typedef T ValueType;
+
+  VTKM_EXEC_EXPORT
+  vtkm::Id GetNumberOfValues() const { return ARRAY_SIZE; }
+
+  VTKM_EXEC_EXPORT
+  ValueType Get(vtkm::Id index) const { return TestValue(index, ValueType()); }
+};
+
+struct VecFromPortalPermuteTestFunctor
+{
+  template<typename T>
+  void operator()(T) const
+  {
+    typedef TestPortal<T> PortalType;
+    typedef vtkm::VecVariable<vtkm::Id,ARRAY_SIZE> IndexVecType;
+    typedef vtkm::exec::internal::VecFromPortalPermute<IndexVecType,PortalType>
+        VecType;
+    typedef vtkm::TypeTraits<VecType> TTraits;
+    typedef vtkm::VecTraits<VecType> VTraits;
+
+    std::cout << "Checking VecFromPortal traits" << std::endl;
+
+    // The statements will fail to compile if the traits is not working as
+    // expected.
+    CheckType(typename TTraits::DimensionalityTag(),
+              vtkm::TypeTraitsVectorTag());
+    CheckType(typename VTraits::ComponentType(), T());
+    CheckType(typename VTraits::HasMultipleComponents(),
+              vtkm::VecTraitsTagMultipleComponents());
+    CheckType(typename VTraits::IsSizeStatic(),
+              vtkm::VecTraitsTagSizeVariable());
+
+    std::cout << "Checking VecFromPortal contents" << std::endl;
+
+    PortalType portal;
+
+    for (vtkm::Id offset = 0; offset < ARRAY_SIZE; offset++)
+    {
+      for (vtkm::IdComponent length = 0;
+           2*length + offset < ARRAY_SIZE;
+           length++)
+      {
+        IndexVecType indices;
+        for (vtkm::IdComponent index = 0; index < length; index++)
+        {
+          indices.Append(offset + 2*index);
+        }
+
+        VecType vec(indices, portal);
+
+        VTKM_TEST_ASSERT(vec.GetNumberOfComponents() == length,
+                         "Wrong length.");
+        VTKM_TEST_ASSERT(VTraits::GetNumberOfComponents(vec) == length,
+                         "Wrong length.");
+
+        vtkm::Vec<T,ARRAY_SIZE> copyDirect;
+        vec.CopyInto(copyDirect);
+
+        vtkm::Vec<T,ARRAY_SIZE> copyTraits;
+        VTraits::CopyInto(vec, copyTraits);
+
+        for (vtkm::IdComponent index = 0; index < length; index++)
+        {
+          T expected = TestValue(2*index+offset, T());
+          VTKM_TEST_ASSERT(test_equal(vec[index], expected), "Wrong value.");
+          VTKM_TEST_ASSERT(
+                test_equal(VTraits::GetComponent(vec, index), expected),
+                "Wrong value.");
+          VTKM_TEST_ASSERT(test_equal(copyDirect[index], expected),
+                           "Wrong copied value.");
+          VTKM_TEST_ASSERT(test_equal(copyTraits[index], expected),
+                           "Wrong copied value.");
+        }
+      }
+    }
+  }
+};
+
+void VecFromPortalPermuteTest()
+{
+  vtkm::testing::Testing::TryTypes(VecFromPortalPermuteTestFunctor(),
+                                   vtkm::TypeListTagCommon());
+}
+
+} // anonymous namespace
+
+int UnitTestVecFromPortalPermute(int, char *[])
+{
+  return vtkm::testing::Testing::Run(VecFromPortalPermuteTest);
+}