Documentaton for U to Z functions.

jfalcou · Jul 17, 2024 · 6d186ef · 6d186ef
1 parent d8c5376
commit 6d186ef
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 19 deletions.
diff --git a/include/eve/module/core/regular/ulpdist.hpp b/include/eve/module/core/regular/ulpdist.hpp
@@ -38,7 +38,7 @@ namespace eve
 //!   @var ulpdist
 //!   @brief Computes the unit in the last place distance of its arguments.
 //!
-//!   **Defined in Header**
+//!   @groupheader{Header file}
 //!
 //!   @code
 //!   #include <eve/module/core.hpp>
@@ -49,26 +49,30 @@ namespace eve
 //!   @code
 //!   namespace eve
 //!   {
-//!      template< eve::value T, eve::value U >
-//!      eve::common_value_t<T, U> ulpdist(T x, U y) noexcept;
+//!      // Regular overload
+//!      constexpr auto ulpdist(floating_value auto x, floating_value auto y)                          noexcept; // 1
+//!
+//!      // Lanes masking
+//!      constexpr auto ulpdist[conditional_expr auto c][floating_value auto x, floating_value auto y) noexcept; // 3
+//!      constexpr auto ulpdist[logical_value auto m](floating_value auto x, floating_value auto y)    noexcept; // 3
 //!   }
 //!   @endcode
 //!
 //!   **Parameters**
 //!
-//!     * `x`, `y` :  [arguments](@ref eve::value).
+//!     * `x`, `y`:  [arguments](@ref eve::value).
+//!     * `c`: [Conditional expression](@ref conditional_expr) masking the operation.
+//!     * `m`: [Logical value](@ref logical) masking the operation.
 //!
 //!    **Return value**
 //!
-//!      Computes [elementwise](@ref glossary_elementwise) the
-//!      'units in the last place' distance
-//!      between `x` and `y`. This is semantically equivalent to:`
-//!
-//!      * if is_ordered(x,y), nb_values(x,y)/2.0 is returned
-//!      * otherwise a `Nan` is returned
+//!      1. Computes [elementwise](@ref glossary_elementwise) the 'units in the last place' distance
+//!         between `x` and `y`.
+//!           * if is_ordered(x,y), nb_values(x,y)/2.0 is returned
+//!           * otherwise a `Nan` is returned
+//!      2. [The operation is performed conditionnaly](@ref conditional).
 //!
 //!  @groupheader{Example}
-//!
 //!  @godbolt{doc/core/ulpdist.cpp}
 //!
 //! @}

diff --git a/include/eve/module/core/regular/unalign.hpp b/include/eve/module/core/regular/unalign.hpp
@@ -46,7 +46,7 @@ namespace eve
 
     EVE_CALLABLE_OBJECT(unalign_t, unalign_);
   };
-
+  // TODO DOC
   //================================================================================================
   //! @addtogroup memory
   //! @{

diff --git a/include/eve/module/core/regular/zip.hpp b/include/eve/module/core/regular/zip.hpp
@@ -42,6 +42,7 @@ namespace eve
     struct filler { EVE_FORCEINLINE auto operator()(auto in, auto *ptr) const { *ptr = in; } };
   };
 
+  // TODO DOC
   //================================================================================================
   //! @addtogroup core_simd
   //! @{

diff --git a/include/eve/module/special/regular/zeta.hpp b/include/eve/module/special/regular/zeta.hpp
@@ -30,7 +30,7 @@ namespace eve
 //!   @var zeta
 //!   @brief Computes the Riemann \f$\zeta\f$ function.
 //!
-//!   **Defined in header**
+//!   @groupheader{Header file}
 //!
 //!   @code
 //!   #include <eve/module/special.hpp>
@@ -41,22 +41,28 @@ namespace eve
 //!   @code
 //!   namespace eve
 //!   {
-//!      template< eve::floating_ordered_value T >
-//!      T zeta(T x) noexcept;
+//!      // Regular overload
+//!      constexpr auto zeta(floating_value auto x)                          noexcept; // 1
+//!
+//!      // Lanes masking
+//!      constexpr auto zeta[conditional_expr auto c](floating_value auto x) noexcept; // 2
+//!      constexpr auto zeta[logical_value auto m](floating_value auto x)    noexcept; // 2
 //!   }
 //!   @endcode
 //!
 //!   **Parameters**
 //!
-//!     * `x` :  [real floating argument](@ref eve::floating_ordered_value).
+//!     * `x`: [floating value](@ref floating_value).
+//!     * `c`: [Conditional expression](@ref conditional_expr) masking the operation.
+//!     * `m`: [Logical value](@ref logical) masking the operation.
 //!
 //!   **Return value**
 //!
-//!   The value of the Riemann function defined as
-//!   \f$\displaystyle \zeta(s)=\sum_{n=0}^\infty \frac1{n^s}\f$ is returned.
+//!     1. The value of the Riemann function defined as
+//!        \f$\displaystyle \zeta(s)=\sum_{n=0}^\infty \frac1{n^s}\f$ is returned.
+//!     2. [The operation is performed conditionnaly](@ref conditional).
 //!
 //!   @groupheader{Example}
-//!
 //!   @godbolt{doc/special/regular/zeta.cpp}
 //! @}
 //================================================================================================