From f7a52a29e5504ec7cb2a908596ab27e6347a01d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Yannik=20M=C3=BCller?= <y.mueller@fz-juelich.de>
Date: Tue, 26 Sep 2023 14:39:14 +0200
Subject: [PATCH] Added documentation fore the linktest_kkernel functions
---
benchmark/vcluster.h | 28 ++++++++++++++++++++++++++--
1 file changed, 26 insertions(+), 2 deletions(-)
diff --git a/benchmark/vcluster.h b/benchmark/vcluster.h
index b516073..b2b6d3d 100644
--- a/benchmark/vcluster.h
+++ b/benchmark/vcluster.h
@@ -228,21 +228,45 @@ public:
*/
virtual std::uint64_t kpingpong_minimal_buffer_overhead() const;
- // Pingpong kernel with warmup.
+ /*! \brief kpingpong with warmup
+ *
+ * This function provides a default implementation for the entire kernel routine including warmup and some reporting
+ * The transport layer implementation is externalised in kpingpong(...)
+ *
+ */
int linktest_kpingpong(int from, int to,
MemoryBuffer& buf,
const struct linktest_args* args,
double* time);
-
+ /*! \brief kUniDir with warmup
+ *
+ * This function provides a default implementation for the entire kernel routine including warmup and some reporting
+ * The transport layer implementation is externalised in kUniDir(...)
+ *
+ */
int linktest_kUniDir(const int from,const int to,
MemoryBuffer& buf1, MemoryBuffer& buf2,
const struct linktest_args* const args,
double* time, const int doBarrier);
+
+ /*! \brief kUniDirMultiBuf with warmup
+ *
+ * This function provides a default implementation for the entire kernel routine including warmup and some reporting
+ * The transport layer implementation is externalised in kUniDirMultiBuf(...)
+ *
+ */
int linktest_kUniDirMultiBuf(const int from,const int to,
MemoryBufferMulti& buf_multi, MemoryBuffer& buf2,
const struct linktest_args* const args,
double* const time, const int doBarrier);
+
+ /*! \brief kUniDirLimitedMultiBuf with warmup
+ *
+ * This function provides a default implementation for the entire kernel routine including warmup and some reporting
+ * The transport layer implementation is externalised in kUniDirLimitedMultiBuf(...)
+ *
+ */
int linktest_kUniDirLimitedMultiBuf(const int from,const int to,
MemoryBufferMulti& buf_multi, MemoryBuffer& buf2,
const struct linktest_args* const args,
--
GitLab