From 55cdf48ce4b40f7d209f96f0d41db106750b117f Mon Sep 17 00:00:00 2001
From: Felix Weiglhofer <weiglhofer@fias.uni-frankfurt.de>
Date: Mon, 26 Jun 2023 08:52:50 +0000
Subject: [PATCH] algo: Add docstring to Sort function.
---
algo/base/compat/Algorithm.h | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/algo/base/compat/Algorithm.h b/algo/base/compat/Algorithm.h
index ab6f32e950..46e93d8a2d 100644
--- a/algo/base/compat/Algorithm.h
+++ b/algo/base/compat/Algorithm.h
@@ -39,6 +39,12 @@ namespace cbm::algo
#endif // WITH_EXECUTION
} // namespace detail
+ /**
+ * @brief Wrapper for std::sort
+ *
+ * Attempts to use the parallel version of std::sort if available. Falls back to the sequential version otherwise.
+ * Parallel version currently requires Linux, GCC compiler and libTBB.
+ */
template<typename It, typename Compare>
void Sort(It first, It last, Compare comp)
{
--
GitLab