comments suppression and adding some doc

jfalcou · Nov 12, 2023 · a9e1c98 · a9e1c98
1 parent 7662685
commit a9e1c98
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 149 deletions.
diff --git a/doc/index.md b/doc/index.md
@@ -106,7 +106,7 @@ Operators
 ---------
 
 Operators (as said before) `+`, `-`, `*` and `/` can be used in infix form and can mix cayley-dickson values of
- different dimensinalities. Of course the biggest dimensionlity is recovered in the output.
+ different dimensionalities. Of course the biggest dimensionlity is recovered in the output.
 
 Prefix forms are also provided as `add`, `sub`, `multiply` and `div`. Also plus and minus for unary versions.
 
@@ -115,10 +115,9 @@ The left division sometimes necessary if the dimensionality is greater than 2 is
 Functions
 ---------
 
-Most **KYOSU** callables are usable with all cayley_dickson types. The exception being mainly special
-complex functions and rotation related quaternion usage.
+Most **KYOSU** callables are usable with all cayley_dickson types. The exceptions mainly being rotation related quaternion usage.
 
-@warning: **EVE** callables that correspond to mathematical functions that
+@warning  **EVE** callables that correspond to mathematical functions that
           are only defined on a proper part of the real axis as, for example, `acos` DOES NOT ever provide the same result
           if called in **EVE** or **KYOSU** context.
 
@@ -163,8 +162,14 @@ complex functions and rotation related quaternion usage.
    | [sqr](@ref kyosu::sqr )                   | [sqr_abs](@ref kyosu::sqr_abs )         | [sqrt](@ref kyosu::sqrt )             | [tan](@ref kyosu::tan )        | [tanpi](@ref kyosu::tanpi )          |
    | [tanh](@ref kyosu::tanh )                 | [to_polar](@ref kyosu::to_polar )       | [tgamma](@ref kyosu::tgamma )         | [trunc](@ref kyosu::trunc )    | [zeta](@ref kyosu::zeta )            |
 
+  * Bessel functions
 
-  * callables usable with quaternion complex and real only
+     They deserve a separate list to avoid verbosity:
+
+     * cylindrical Bessel functions: cyl_bessel_xxx are all defined for xxx being j0, j1, jn, y0, y1, yn, i0, i1, in, h1_0, h1_1, h1n, h2_0, h2_1, h2n, k1, k0, kn.
+     * spherical   Bessel functions: sph_bessel_xxx are all defined for xxx being j0, j1, jn, y0, y1, yn, i1_0, i1_1, i1n, i2_0, i2_1, i2n, h1_0, h1_1, h1n, h2_0, h2_1 h2n, k1, k0, kn.
+
+  * Callables usable with quaternion complex and real only
 
     These functions are related to \f$\mathbb{R}^3\f$ rotations
 

diff --git a/include/kyosu/functions/cyl_bessel_i1.hpp b/include/kyosu/functions/cyl_bessel_i1.hpp
@@ -40,7 +40,7 @@ namespace kyosu
 //! @{
 //!   @var cyl_bessel_i1
 //!   @brief Computes  the modified Bessel function of the first kind,
-//!   \f$ I_1(x)= _iJ_1(ix) \f$ extended to the complex plane and cayley_dickson algebras.
+//!   \f$ I_1(x)= iJ_1(ix) \f$ extended to the complex plane and cayley_dickson algebras.
 //!
 //!   It is the solution of \f$ x^{2}y''+xy'+x^2y=0\f$ for which \f$ y(0) = 0\f$.
 //!

diff --git a/include/kyosu/functions/cyl_seq.hpp b/include/kyosu/functions/cyl_seq.hpp
diff --git a/include/kyosu/functions/from_angle_axis.hpp b/include/kyosu/functions/from_angle_axis.hpp
@@ -26,10 +26,6 @@ namespace kyosu::tags
     {
       auto fn = callable_from_angle_axis{};
       return fn(angle, axis, normalize);
-//       using e_t = decltype(axis[0]+angle);
-//       auto q =  quaternion(e_t(0), e_t(axis[0]), e_t(axis[1]), e_t(axis[2]));
-//       auto [s, c] = eve::sincos(angle*eve::half(eve::as(angle)));
-//       return c+s*q;
     }
 
     template<eve::floating_ordered_value V,  typename  U, bool n>

diff --git a/include/kyosu/types/impl/detail/bessel_h.hpp b/include/kyosu/types/impl/detail/bessel_h.hpp
@@ -72,38 +72,6 @@ namespace kyosu::_
       {
         using u_t   =  eve::underlying_type_t<Z>;
         return eve::sign_alternate(u_t(n))*sph_bessel_h2n(n, -z);
- //        auto imzge0 = eve::is_gez(imag(z));
-//         using u_t   =  eve::underlying_type_t<Z>;
-//         auto i = complex(u_t(0), u_t(1));
-//         auto rz = rec(z);
-//         auto iz = complex(-ipart(z), real(z));
-//         auto h0 = -i*exp(iz)/z;
-//         if(n == 0) return h0;
-//         auto h1 = (rz-i)*h0;
-//         if(n == 1) return h1;
-
-//         auto br_imzge0 = [&h0, &h1, rz, n](){
-//           std::cout << "icitte" << std::endl;
-//           auto h2 = h1;
-//           for(int i=1; i < n; ++i)
-//           {
-//             auto f = (2*i+1)*rz;
-//             h2 = f*h1-h0;
-//             h0 = h1;
-//             h1 = h2;
-//           }
-//           return h2;
-//         };
-
-//         auto br_imzlt0 = [n, z](){
-//           std::cout << "latte" << std::endl;
-//           return eve::sign_alternate(u_t(n))*sph_bessel_h2n(n, -z);// 2*sph_bessel_jn(n, z)-sph_bessel_h2n(n, z);
-//         };
-
-//         auto res = br_imzge0();
-//         if (eve::all(imzge0)) return res;
-//         auto res1 = br_imzlt0();
-//         return if_else(imzge0, res, res1);
       }
     }
     else

diff --git a/include/kyosu/types/impl/detail/bessel_k.hpp b/include/kyosu/types/impl/detail/bessel_k.hpp
@@ -29,8 +29,6 @@ namespace kyosu::_
       auto epio2 = exp_ipi(eve::half(eve::as<u_t>()));
       auto empio2 = exp_ipi(eve::mhalf(eve::as<u_t>()));
       auto argzlt0 = eve::is_ltz(argz);
-//       auto z1 = if_else(argzlt0, z, zero(as(z)));
-//       auto z2 = if_else(argzlt0, zero(as(z)), z);
       auto r =  if_else(argzlt0
                        , cpi*cyl_bessel_h1n(n, z*epio2)
                        , cmi*cyl_bessel_h2n(n, z*empio2));