refs #148 Больше комментариев

izvolov · Aug 18, 2021 · 051ec4f · 051ec4f
1 parent b211d44
commit 051ec4f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/include/burst/algorithm/radix_sort.hpp b/include/burst/algorithm/radix_sort.hpp
@@ -113,6 +113,23 @@ namespace burst
         detail::radix_sort_impl(first, last, buffer, compose(to_unsigned, std::move(map)), radix);
     }
 
+    /*!
+        \brief
+            Параллельный вариант поразрядной сортировки
+
+        \details
+            Пытается создать пул с указанным количеством рабочих потоков и вызвать параллельную
+            реализацию поразрядки.
+            Если потоков указано слишком мало (меньше двух) или диапазон слишком маленький, чтобы
+            сортировать его в указанном количестве потоков, то происходит откат на последовательный
+            вариант алгоритма.
+
+        \param par
+            Тег, указывающий на то, что нужно вызвать параллельный вариант алгоритма.
+            Содержит в себе желаемое количество потоков для параллелизации.
+
+        \see parallel_policy
+     */
     template
     <
         typename RandomAccessIterator1,

diff --git a/include/burst/execution/parallel_policy.hpp b/include/burst/execution/parallel_policy.hpp
@@ -6,8 +6,14 @@
 
 namespace burst
 {
+    /*!
+        \brief
+            Тег, используемый для перегрузки функций, чтобы указать, что нужно вызвать параллельный
+            вариант алгоритма
+     */
     struct parallel_policy
     {
+        //! Желаемое количество потоков для параллелизации.
         std::size_t thread_count;
     };