Hints.h

Go to the documentation of this file.

//============================================================================
//  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_internal_Hints_h
#define vtk_m_cont_internal_Hints_h
 
#include <vtkm/Assert.h>
#include <vtkm/List.h>
 
#include <vtkm/cont/DeviceAdapterTag.h>
 
namespace vtkm
{
namespace cont
{
namespace internal
{
 
template <typename Derived_, typename Tag_, typename DeviceList_>
struct HintBase
{
  using Derived = Derived_;
  using Tag = Tag_;
  using DeviceList = DeviceList_;
};
 
struct HintTagThreadsPerBlock
{
};
 
template <vtkm::IdComponent MaxThreads_, typename DeviceList_ = vtkm::ListUniversal>
struct HintThreadsPerBlock
  : HintBase<HintThreadsPerBlock<MaxThreads_, DeviceList_>, HintTagThreadsPerBlock, DeviceList_>
{
  static constexpr vtkm::IdComponent MaxThreads = MaxThreads_;
};
 
template <typename... Hints>
struct HintList : vtkm::List<Hints...>
{
  using List = vtkm::List<Hints...>;
};
 
template <typename T>
struct IsHintList : std::false_type
{
};
template <typename... Hints>
struct IsHintList<HintList<Hints...>> : std::true_type
{
};
 
#define VTKM_IS_HINT_LIST(T) VTKM_STATIC_ASSERT(::vtkm::cont::internal::IsHintList<T>::value)
 
namespace detail
{
 
template <typename Device, typename HintTag>
struct FindHintOperators
{
  VTKM_IS_DEVICE_ADAPTER_TAG(Device);
 
  template <typename Hint>
  using HintMatches = vtkm::internal::meta::And<std::is_same<typename Hint::Tag, HintTag>,
                                                vtkm::ListHas<typename Hint::DeviceList, Device>>;
  template <typename Found, typename Next>
  using ReduceOperator = typename std::conditional<HintMatches<Next>::value, Next, Found>::type;
};
 
} // namespace detail
 
template <typename HList, typename DefaultHint, typename Device>
using HintFind = vtkm::ListReduce<
  typename HList::List,
  detail::FindHintOperators<Device, typename DefaultHint::Tag>::template ReduceOperator,
  DefaultHint>;
 
}
}
} // namespace vtkm::cont::internal
 
#endif // vtk_m_cont_internal_Hints_h