Exposing compress in the public api (#1646)

* moving compress files * cleaning up compress
jfalcou · Aug 21, 2023 · b59a564 · b59a564
1 parent 19c4348
commit b59a564
Show file tree

Hide file tree

Showing 49 changed files with 844 additions and 384 deletions.
diff --git a/include/eve/detail/compress/compress.hpp b/include/eve/detail/compress/compress.hpp
diff --git a/include/eve/detail/compress/simd/common/compress.hpp b/include/eve/detail/compress/simd/common/compress.hpp
diff --git a/include/eve/detail/compress/simd/x86/compress.hpp b/include/eve/detail/compress/simd/x86/compress.hpp
diff --git a/include/eve/detail/function/compress_store_impl.hpp b/include/eve/detail/function/compress_store_impl.hpp
diff --git a/include/eve/detail/function/simd/common/compress_store_impl.hpp b/include/eve/detail/function/simd/common/compress_store_impl.hpp
diff --git a/include/eve/module/algo/algo/fill.hpp b/include/eve/module/algo/algo/fill.hpp
@@ -18,7 +18,7 @@ namespace eve::algo
 {
 
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var fill
   //!  @brief a version of `std::fill`

diff --git a/include/eve/module/algo/algo/for_each.hpp b/include/eve/module/algo/algo/for_each.hpp
@@ -17,7 +17,7 @@
 namespace eve::algo
 {
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var for_each
   //!  @brief a basic for_each algorithm.

diff --git a/include/eve/module/algo/algo/iota.hpp b/include/eve/module/algo/algo/iota.hpp
@@ -14,7 +14,7 @@
 namespace eve::algo
 {
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var iota
   //!

diff --git a/include/eve/module/algo/algo/remove.hpp b/include/eve/module/algo/algo/remove.hpp
@@ -62,6 +62,22 @@ namespace eve::algo
     }
   };
 
+  //================================================================================================
+  //! @addtogroup algos
+  //! @{
+  //!  @var remove_if
+  //!  @brief SIMD version of std::remove_if
+  //!
+  //!   **Defined in Header**
+  //!
+  //!   @code
+  //!   #include <eve/module/algo.hpp>
+  //!   @endcode
+  //!
+  //!   TODO: docs
+  //!
+  //! @}
+  //================================================================================================
   inline constexpr auto remove_if = function_with_traits<remove_if_>[no_traits];
 
   template <typename TraitsSupport>
@@ -74,5 +90,21 @@ namespace eve::algo
     }
   };
 
+ //================================================================================================
+  //! @addtogroup algos
+  //! @{
+  //!  @var remove
+  //!  @brief SIMD version of std::remove
+  //!
+  //!   **Defined in Header**
+  //!
+  //!   @code
+  //!   #include <eve/module/algo.hpp>
+  //!   @endcode
+  //!
+  //!   TODO: docs
+  //!
+  //! @}
+  //================================================================================================
   inline constexpr auto remove = function_with_traits<remove_>[no_traits];
 }
diff --git a/include/eve/module/algo/algo/reverse.hpp b/include/eve/module/algo/algo/reverse.hpp
@@ -17,7 +17,7 @@
 namespace eve::algo
 {
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var reverse
   //!
@@ -75,7 +75,7 @@ namespace eve::algo
   inline constexpr auto reverse = function_with_traits<reverse_>[no_unrolling][no_aligning];
 
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var reverse_copy
   //!

diff --git a/include/eve/module/algo/algo/swap_ranges.hpp b/include/eve/module/algo/algo/swap_ranges.hpp
@@ -15,7 +15,7 @@
 namespace eve::algo
 {
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var swap_ranges
   //!

diff --git a/include/eve/module/algo/algo/transform.hpp b/include/eve/module/algo/algo/transform.hpp
@@ -43,7 +43,7 @@ namespace eve::algo
   }
 
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var transform_inplace
   //!
@@ -72,7 +72,7 @@ namespace eve::algo
   inline constexpr auto transform_inplace = function_with_traits<transform_inplace_>[default_simple_algo_traits];
 
   //================================================================================================
-  //! @addtogroup algorithms
+  //! @addtogroup algos
   //! @{
   //!  @var transform_to
   //!

diff --git a/include/eve/module/core.hpp b/include/eve/module/core.hpp
@@ -93,9 +93,16 @@
 //! @ingroup core
 //! Functions that are just shuffles with a different api.
 //!
+//! @defgroup core_comporess Compress functions
+//! @ingroup core
+//! Functions that in different way expose `compressing` selected elements
+//! together to beginning. This is at the core of `remove_if`, `copy_if` etc.
+//! Alternative search keywords: filter, remove, pack
+//!
 //! @}
 //==================================================================================================
 
+#include <eve/module/core/compress/core.hpp>
 #include <eve/module/core/constant/core.hpp>
 #include <eve/module/core/decorator/core.hpp>
 #include <eve/module/core/detail/core.hpp>