Skip to content

Commit

Permalink
special
Browse files Browse the repository at this point in the history
  • Loading branch information
@jtlap
jtlap committed Oct 10, 2023
1 parent d44368a commit ea547e9
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 114 deletions.
24 changes: 3 additions & 21 deletions include/eve/module/special/regular/beta.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,39 +28,21 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_ordered_value T, eve::floating_ordered_value U >
//! auto beta(T x,U y) noexcept; //1
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto beta(eve::as_complex_t<T> x, U y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto beta(T x, eve::as_complex_t<U> y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto beta(eve::as_complex_t<T> x, eve::as_complex_t<U> y) noexcept; //2
//! }
//! auto beta(T x,U y) noexcept;
//! @endcode
//!
//! **Parameters**
//!
//! 1. `x`, `y`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//! 2. `x`, `y`: [real floating](@ref eve::floating_value) or [complex ](@ref eve::complex) arguments.
//! `x`, `y`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//!
//! **Return value**
//!
//! 1. \f$\displaystyle \mathbf{B}(x,y) = \int_0^1 t^{x-1}(1-t)^{y-1}\mbox{d}t\f$
//! 2. The complex \f$\displaystyle \mathbb{B}(x,y) = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)}\f$ is returned.
//! * \f$\displaystyle \mathbf{B}(x,y) = \int_0^1 t^{x-1}(1-t)^{y-1}\mbox{d}t\f$
//!
//! @groupheader{Example}
//!
//! **Real version**
//!
//! @godbolt{doc/special/regular/beta.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/beta.cpp}
//!
//! @}
//================================================================================================
EVE_MAKE_CALLABLE(beta_, beta);
Expand Down
6 changes: 0 additions & 6 deletions include/eve/module/special/regular/digamma.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,14 @@ namespace eve
//!
//! **Parameters**
//!
//! `x`: [real](@ref eve::value) or [complex](@ref eve::complex) argument.
//!
//! **Return value**
//!
//! The value of the Digamma function: \f$\frac{\Gamma'(x)}{\Gamma(x)}\f$ is returned.
//!
//! @groupheader{Example}
//! **Real version**
//!
//! @godbolt{doc/special/regular/digamma.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/digamma.cpp}
//!
//! @}
//================================================================================================
Expand Down
11 changes: 1 addition & 10 deletions include/eve/module/special/regular/erf.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,13 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_ordered_value T >
//! T erf(T x) noexcept; //1
//!
//! template< eve::floating_value T >
//! eve::complex<T> erf(eve::complex<T> z) noexcept; //2
//! T erf(T x) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! * `x` : [real floating argument](@ref eve::floating_ordered_value).
//! * `z`: [complex ](@ref eve::complex) value.
//!
//! **Return value**
//!
Expand All @@ -53,13 +49,8 @@ namespace eve
//!
//! @groupheader{Example}
//!
//! **Real version**
//!
//! @godbolt{doc/special/regular/erf.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/erf.cpp}
//! @}
//================================================================================================
EVE_MAKE_CALLABLE(erf_, erf);
Expand Down
19 changes: 2 additions & 17 deletions include/eve/module/special/regular/lbeta.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,18 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_ordered_value T, eve::floating_ordered_value U >
//! auto lbeta(T x,U y) noexcept; //1
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto lbeta(eve::as_complex_t<T> x, U y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! autol beta(T x, eve::as_complex_t<U> y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto lbeta(eve::as_complex_t<T> x, eve::as_complex_t<U> y) noexcept; //2
//! auto lbeta(T x,U y) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! 1. `x`, `y`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//! 2. `x`, `y`: [real floating](@ref eve::floating_value) or [complex ](@ref eve::complex) arguments.
//! `x`, `y`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//!
//! **Return value**
//!
//! **Real version**
//!
//! @godbolt{doc/special/regular/lbeta.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/lbeta.cpp}
//!
//! @}
//================================================================================================
Expand Down
6 changes: 1 addition & 5 deletions include/eve/module/special/regular/log_abs_gamma.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,13 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_value T >
//! T log_abs_gamma(T x) noexcept; //1
//!
//! template< eve::floating_value T >
//! T log_abs_gamma(as_complex_t<T> T z) noexcept; //2
//! T log_abs_gamma(T x) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! * `x` : [real argument](@ref eve::value).
//! * `z` : [complex argument ](@ref eve::complex).
//!
//! **Return value**
//!
Expand Down
6 changes: 0 additions & 6 deletions include/eve/module/special/regular/log_gamma.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ namespace eve
//!
//! **Parameters**
//!
//! * `x` : [real](@ref eve::value) or [complex](@ref eve::complex) argument.
//!
//! **Return value**
//!
Expand All @@ -47,13 +46,8 @@ namespace eve
//!
//! @groupheader{Example}
//!
//! **Real version**
//!
//! @godbolt{doc/special/regular/log_gamma.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/log_gamma.cpp}
//! @}
//================================================================================================
EVE_MAKE_CALLABLE(log_gamma_, log_gamma);
Expand Down
19 changes: 2 additions & 17 deletions include/eve/module/special/regular/lrising_factorial.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,37 +30,22 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_ordered_value T, eve::floating_ordered_value U >
//! auto lrising_factorial(T x,U y) noexcept; //1
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto lrising_factorial(eve::as_complex_t<T> x, U y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto lrising_factorial(T x, eve::as_complex_t<U> y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto lrising_factorial(eve::as_complex_t<T> x, eve::as_complex_t<U> y) noexcept; //2
//! auto lrising_factorial(T x,U y) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! 1. `a`, `x`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//! 2. `a`, `x`: [real floating](@ref eve::floating_value) or [complex ](@ref eve::complex) arguments.
//! `a`, `x`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//!
//! **Return value**
//!
//! The value of the natural logarithm of the rising_factorial is returned.
//!
//! @groupheader{Example}
//!
//! **Real version**
//!
//! @godbolt{doc/special/regular/lrising_factorial.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/lrising_factorial.cpp}
//!
//! @groupheader{Semantic Modifiers}
//!
Expand Down
17 changes: 2 additions & 15 deletions include/eve/module/special/regular/rising_factorial.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,13 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_ordered_value T, eve::floating_ordered_value U >
//! auto rising_factorial(T x,U y) noexcept; //1
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto rising_factorial(eve::as_complex_t<T> x, U y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto rising_factorial(T x, eve::as_complex_t<U> y) noexcept; //2
//!
//! template< eve::floating_value T, eve::floating_value U >
//! auto rising_factorial(eve::as_complex_t<T> x, eve::as_complex_t<U> y) noexcept; //2
//! auto rising_factorial(T x,U y) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! 1. `a`, `x`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//! 2. `a`, `x`: [real floating](@ref eve::floating_value) or [complex ](@ref eve::complex) arguments.
//! `a`, `x`: [strictly positive real floating argument](@ref eve::floating_ordered_value).
//!
//! **Return value**
//!
Expand All @@ -55,9 +45,6 @@ namespace eve
//!
//! @godbolt{doc/special/regular/rising_factorial.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/rising_factorial.cpp}
//!
//! @groupheader{Semantic Modifiers}
//!
Expand Down
11 changes: 1 addition & 10 deletions include/eve/module/special/regular/tgamma.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,31 +30,22 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_value T >
//! T tgamma(T x) noexcept; //1
//!
//! template< eve::floating_value T >
//! eve::complex<T> tgamma(eve::complex<T> z) noexcept; //2
//! T tgamma(T x) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! * `x`: [floating real value](@ref eve::floating_ordered_value).
//! * `z`: [complex ](@ref eve::complex) value.
//!
//! **Return value**
//!
//! The value of \f$\Gamma\f$ is returned.
//!
//! @groupheader{Example}
//!
//! **Real version**
//!
//! @godbolt{doc/special/regular/tgamma.cpp}
//!
//! **Complex version**
//!
//! @godbolt{doc/complex/regular/tgamma.cpp}
//!
//! @}
//================================================================================================
Expand Down
9 changes: 2 additions & 7 deletions include/eve/module/special/regular/zeta.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,18 @@ namespace eve
//! namespace eve
//! {
//! template< eve::floating_ordered_value T >
//! T zeta(T x) noexcept; //1
//!
//! template< eve::floating_value T >
//! eve::complex<T> zeta(eve::complex<T> z) noexcept; //2
//! T zeta(T x) noexcept;
//! }
//! @endcode
//!
//! **Parameters**
//!
//! * `x` : [real floating argument](@ref eve::floating_ordered_value).
//! * `z`: [complex ](@ref eve::complex) value.
//!
//! **Return value**
//!
//! The value of the Riemann function defined as
//! \f$\displaystyle \zeta(s)=\sum_{n=0}^\infty \frac1{n^s}\f$ or its analytic continuation
//! in the complex plane is returned.
//! \f$\displaystyle \zeta(s)=\sum_{n=0}^\infty \frac1{n^s}\f$ is returned.
//!
//! @groupheader{Example}
//!
Expand Down

0 comments on commit ea547e9

Please sign in to comment.