for_each.hpp

Go to the documentation of this file.

 
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
// Copyright (c) Lawrence Livermore National Security, LLC and other
// RAJA Project Developers. See top-level LICENSE and COPYRIGHT
// files for dates and other details. No copyright assignment is required
// to contribute to RAJA.
//
// SPDX-License-Identifier: (BSD-3-Clause)
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~//
 
#ifndef RAJA_util_for_each_HPP
#define RAJA_util_for_each_HPP
 
#include "RAJA/config.hpp"
 
#include <iterator>
#include <type_traits>
 
#include "camp/list.hpp"
 
#include "RAJA/pattern/detail/algorithm.hpp"
 
#include "RAJA/util/macros.hpp"
#include "RAJA/util/types.hpp"
 
namespace RAJA
{
 
namespace detail
{
 
// runtime loop applying func to each element in the range in order
RAJA_SUPPRESS_HD_WARN
template<typename Iter, typename UnaryFunc>
constexpr RAJA_HOST_DEVICE RAJA_INLINE UnaryFunc for_each(Iter begin,
                                                          Iter end,
                                                          UnaryFunc func)
{
  for (; begin != end; ++begin)
  {
    func(*begin);
  }
 
  return func;
}
 
// compile time expansion applying func to a each type in the list in order
RAJA_SUPPRESS_HD_WARN
template<typename UnaryFunc, typename... Ts>
constexpr RAJA_HOST_DEVICE RAJA_INLINE UnaryFunc
for_each_type(camp::list<Ts...> const&, UnaryFunc func)
{
  // braced init lists are evaluated in order
  int seq_unused_array[] = {0, (func(Ts {}), 0)...};
  RAJA_UNUSED_VAR(seq_unused_array);
 
  return func;
}
 
// compile time expansion applying func to a each type in the tuple in order
RAJA_SUPPRESS_HD_WARN
template<typename Tuple, typename UnaryFunc, camp::idx_t... Is>
constexpr RAJA_HOST_DEVICE RAJA_INLINE UnaryFunc
for_each_tuple(Tuple&& t, UnaryFunc func, camp::idx_seq<Is...>)
{
  using camp::get;
  // braced init lists are evaluated in order
  int seq_unused_array[] = {0, (func(get<Is>(std::forward<Tuple>(t))), 0)...};
  RAJA_UNUSED_VAR(seq_unused_array);
 
  return func;
}
 
}  // namespace detail
 
RAJA_SUPPRESS_HD_WARN
template<typename Container, typename UnaryFunc>
constexpr RAJA_HOST_DEVICE RAJA_INLINE
    concepts::enable_if_t<UnaryFunc, type_traits::is_range<Container>>
    for_each(Container&& c, UnaryFunc func)
{
  using std::begin;
  using std::end;
 
  return detail::for_each(begin(c), end(c), std::move(func));
}
 
RAJA_SUPPRESS_HD_WARN
template<typename UnaryFunc, typename... Ts>
constexpr RAJA_HOST_DEVICE RAJA_INLINE UnaryFunc
for_each_type(camp::list<Ts...> const& c, UnaryFunc func)
{
  return detail::for_each_type(c, std::move(func));
}
 
RAJA_SUPPRESS_HD_WARN
template<typename Tuple, typename UnaryFunc>
constexpr RAJA_HOST_DEVICE RAJA_INLINE UnaryFunc for_each_tuple(Tuple&& t,
                                                                UnaryFunc func)
{
  return detail::for_each_tuple(
      std::forward<Tuple>(t), std::move(func),
      camp::make_idx_seq_t<std::tuple_size<camp::decay<Tuple>>::value> {});
}
 
}  // namespace RAJA
 
#endif