Skip to content
Snippets Groups Projects
Commit f7a52a29 authored by Yannik Müller's avatar Yannik Müller
Browse files

Added documentation fore the linktest_kkernel functions

parent 16d430e1
Branches
No related tags found
No related merge requests found
...@@ -228,21 +228,45 @@ public: ...@@ -228,21 +228,45 @@ public:
*/ */
virtual std::uint64_t kpingpong_minimal_buffer_overhead() const; 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, int linktest_kpingpong(int from, int to,
MemoryBuffer& buf, MemoryBuffer& buf,
const struct linktest_args* args, const struct linktest_args* args,
double* time); 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, int linktest_kUniDir(const int from,const int to,
MemoryBuffer& buf1, MemoryBuffer& buf2, MemoryBuffer& buf1, MemoryBuffer& buf2,
const struct linktest_args* const args, const struct linktest_args* const args,
double* time, const int doBarrier); 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, int linktest_kUniDirMultiBuf(const int from,const int to,
MemoryBufferMulti& buf_multi, MemoryBuffer& buf2, MemoryBufferMulti& buf_multi, MemoryBuffer& buf2,
const struct linktest_args* const args, const struct linktest_args* const args,
double* const time, const int doBarrier); 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, int linktest_kUniDirLimitedMultiBuf(const int from,const int to,
MemoryBufferMulti& buf_multi, MemoryBuffer& buf2, MemoryBufferMulti& buf_multi, MemoryBuffer& buf2,
const struct linktest_args* const args, const struct linktest_args* const args,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment