deta to dot

jfalcou · Sep 27, 2023 · b9cbb4c · b9cbb4c
1 parent 4f38db0
commit b9cbb4c
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 21 deletions.
diff --git a/include/kyosu/complex/deta.hpp b/include/kyosu/complex/deta.hpp
@@ -43,7 +43,7 @@ namespace kyosu
 //! @addtogroup functions
 //! @{
 //!   @var deta
-//!   @brief Computes the Dirichlet sums \f$ \displaystyle \sum_0^\infty \frac{(-1)^n}{(kn+1)^z}\f$.
+//!   @brief Computes the Dirichlet sums \f$ \displaystyle \sum_{n = 0}^\infty \frac{(-1)^n}{(kn+1)^z}\f$.
 //!
 //!   **Defined in Header**
 //!
@@ -56,19 +56,19 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!      template<unsigned_scalar_value K, eve::ordered_value T>       constexpr auto deta(K, k, T z) noexcept;  //1
-//!      template<unsigned_scalar_value K, kyosu::concepts::complex T> constexpr auto deta(K, k, T z) noexcept;  //2
+//!      template<unsigned_scalar_value K, eve::ordered_value T>       constexpr auto deta(K k, T z) noexcept;  //1
+//!      template<unsigned_scalar_value K, kyosu::concepts::complex T> constexpr auto deta(K k, T z) noexcept;  //2
 //!   }
 //!   @endcode
 //!
 //!   **Parameters**
 //!
 //!     * `k` : scalar unsigned value,  parameter of the sum.
-//!     * `z` : Vcomplex or real value to process.
+//!     * `z` : complex or real value to process.
 //!
 //! **Return value**
 //!
-//!   Returns the Dirichlet sum \f$  \displaystyle \sum_0^\infty \frac{(-1)^n}{(kn+1)^z}\f$
+//!   Returns the Dirichlet sum \f$  \displaystyle \sum_{n = 0}^\infty \frac{(-1)^n}{(kn+1)^z}\f$
 //!
 //!  @groupheader{Example}
 //!

diff --git a/include/kyosu/complex/digamma.hpp b/include/kyosu/complex/digamma.hpp
@@ -39,7 +39,7 @@ namespace kyosu
 //! @addtogroup functions
 //! @{
 //!   @var digamma
-//!   @brief Computes the Digamma function i.e. the logarithmic derivative of the \f$\Gamma\f$
+//!   @brief Computes the Digamma function i.e. the logarithmic derivative of the \f$\Gamma\f$ function
 //!
 //!   **Defined in Header**
 //!
@@ -59,7 +59,7 @@ namespace kyosu
 //!
 //!   **Parameters**
 //!
-//!     * `z` : Value to process.
+//!     * `z` : rel or complex value to process.
 //!
 //!   **Return value**
 //!

diff --git a/include/kyosu/functions/dec.hpp b/include/kyosu/functions/dec.hpp
@@ -43,7 +43,7 @@ namespace kyosu
 //!   **Defined in Header**
 //!
 //!   @code
-//!   #declude <kyosu/functions.hpp>
+//!   #include <kyosu/functions.hpp>
 //!   @endcode
 //!
 //!   @groupheader{Callable Signatures}
@@ -52,7 +52,7 @@ namespace kyosu
 //!   namespace kyosu
 //!   {
 //!      template<kyosu::concepts::cayley_dickson T> constexpr T dec(T z) noexcept;
-//!      template<eve::floating_ordered_value T>              constexpr T dec(T z) noexcept;
+//!      template<eve::floating_ordered_value T>     constexpr T dec(T z) noexcept;
 //!   }
 //!   @endcode
 //!

diff --git a/include/kyosu/functions/dist.hpp b/include/kyosu/functions/dist.hpp
@@ -55,20 +55,18 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!      template<kyosu::concepts::cayley_dickson T0, kyosu::concepts::cayley_dickson T1 > constexpr auto dist(T0 z0, T1, z1) noexcept;
-//!      template<eve::floating_ordered_value T0, kyosu::concepts::cayley_dickson T1>             > constexpr auto dist(T0 z0, T1, z1) noexcept;
-//!      template<kyosu::concepts::cayley_dickson T0,  eve::floating_ordered_value T1             > constexpr auto dist(T0 z0, T1, z1) noexcept;
-//!      template<eve::floating_ordered_value T0, floating_ordered_value T1>                               > constexpr auto dist(T0 z0, T1, z1) noexcept;
-///!   }
+//!     constexpr auto dist(auto z0,  auto z1) noexcept;
+//!   }
 //!   @endcode
 //!
 //!   **Parameters**
 //!
-//!     * `z0, z1` : Value to process.
+//!     * `z0, z1` : Values to process.
 //!
 //!   **Return value**
 //!
 //!     Returns the distance between the two arguments computed as the absolute value of the arguments difference.
+//!     Arguments can be a mix of floting or Cayley-Dicson values.
 //!
 //!  @groupheader{Example}
 //!

diff --git a/include/kyosu/functions/dot.hpp b/include/kyosu/functions/dot.hpp
@@ -55,20 +55,18 @@ namespace kyosu
 //!   @code
 //!   namespace kyosu
 //!   {
-//!      template<kyosu::concepts::cayley_dickson T0, kyosu::concepts::cayley_dickson T1 > constexpr auto dot(T0 z0, T1, z1) noexcept;
-//!      template<eve::floating_ordered_value T0, kyosu::concepts::cayley_dickson T1>             > constexpr auto dot(T0 z0, T1, z1) noexcept;
-//!      template<kyosu::concepts::cayley_dickson T0,  eve::floating_ordered_value T1             > constexpr auto dot(T0 z0, T1, z1) noexcept;
-//!      template<eve::floating_ordered_value T0, floating_ordered_value T1>                               > constexpr auto dot(T0 z0, T1, z1) noexcept;
-///!   }
+//!      constexpr auto dot(auto z0,  auto z1) noexcept;
+//!   }
 //!   @endcode
 //!
 //!   **Parameters**
 //!
-//!     * `z0, z1` : Value to process.
+//!     * `z0, z1` : Values to process.
 //!
 //!   **Return value**
 //!
 //!     Returns the dot product of z0 and z1. If z0 and z1 are floating point this is equivalent to z0*z1.
+//!     Arguments can be a mix of floting or Cayley-Dicson values.
 //!
 //!     `dot(z0, z0)` is always semantically equivalent to `sqr_abs(z0)`.
 //!