PackTraits

kokkos · Mar 12, 2024 · 602e080 · 602e080
1 parent e7c4075
commit 602e080
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/docs/api/traits.rst b/docs/api/traits.rst
@@ -41,4 +41,16 @@ Strategies for handling non-contiguous views
 .. cpp:type:: template<typename View> \
               KokkosComm::PackTraits
 
-    A common packing-related interface for Kokkos::View- and std::mdspan-like types.
+    A common packing-related interface for Kokkos::View- and std::mdspan-like types.
+
+  .. cpp:type:: packer_type
+
+    The Packer to use for this ``View`` type.
+
+  .. cpp:function:: static bool needs_unpack(const View &v)
+
+    :returns: true iff ``View`` ``v`` needs to be packed before being passed to MPI
+
+  .. cpp:function:: static bool needs_pack(const View &v)
+
+    :returns: true iff ``View`` ``v`` needs to be unpacked after being passed from MPI