From 382d5b18c79339876b56358418600dbce44991b1 Mon Sep 17 00:00:00 2001 From: Baptiste Legouix Date: Mon, 30 Dec 2024 09:53:48 +0000 Subject: [PATCH] doc --- include/ddc/transform_reduce.hpp | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/ddc/transform_reduce.hpp b/include/ddc/transform_reduce.hpp index 3a8fea38c..ab494a66c 100644 --- a/include/ddc/transform_reduce.hpp +++ b/include/ddc/transform_reduce.hpp @@ -120,6 +120,14 @@ T transform_reduce( std::forward(transform)); } +/** A reduction over a nD domain in serial. Can be called from a device kernel. + * @param[in] domain the range over which to apply the algorithm + * @param[in] neutral the neutral element of the reduction operation + * @param[in] reduce a binary FunctionObject that will be applied in unspecified order to the + * results of transform, the results of other reduce and neutral. + * @param[in] transform a unary FunctionObject that will be applied to each element of the input + * range. The return type must be acceptable as input to reduce + */ template KOKKOS_FUNCTION T annotated_transform_reduce( DiscreteDomain const& domain,