Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cayley/revisiting docs #33

Merged
merged 20 commits into from
Oct 8, 2023
9 changes: 6 additions & 3 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,10 @@ complex functions and rotation related quaternion usage.
| [cospi](@ref kyosu::cospi ) | [cot](@ref kyosu::cot ) | [cotpi](@ref kyosu::cotpi ) | [coth](@ref kyosu::coth ) | [convert](@ref kyosu::convert ) |
| [csc](@ref kyosu::csc ) | [cscpi](@ref kyosu::cscpi ) | [csch](@ref kyosu::csch ) | [dec](@ref kyosu::dec ) | [dist](@ref kyosu::dist ) |
| [dot](@ref kyosu::dot ) | [exp](@ref kyosu::exp ) | [exp10](@ref kyosu::exp10 ) | [exp2](@ref kyosu::exp2 ) | [exp_i](@ref kyosu::exp_i ) |
| [exp_ipi](@ref kyosu::exp_ipi ) | [expm1](@ref kyosu::expm1 ) | [expmx2](@ref kyosu::expmx2 ) | [expx2](@ref kyosu::expx2 ) | [floor](@ref kyosu::floor ) |
| [frac](@ref kyosu::frac ) | [from_polar](@ref kyosu::from_polar ) | [hypot](@ref kyosu::hypot ) | [if_else](@ref kyosu::if_else )| [inc](@ref kyosu::inc ) |
| [exp_ipi](@ref kyosu::exp_ipi ) | [expm1](@ref kyosu::expm1 ) | [expmx2](@ref kyosu::expmx2 ) | [expx2](@ref kyosu::expx2 ) | [fam](@ref kyosu::fam ) |
| [floor](@ref kyosu::floor ) | [fma](@ref kyosu::fma ) | [fms](@ref kyosu::fms ) | [fnma](@ref kyosu::fnma ) | [fnms](@ref kyosu::fnms ) |
| [frac](@ref kyosu::frac ) | [fsm](@ref kyosu::fsm ) | [from_polar](@ref kyosu::from_polar ) | [horner](@ref kyosu::horner ) | [hypot](@ref kyosu::hypot ) |
| [if_else](@ref kyosu::if_else ) | [inc](@ref kyosu::inc ) ||||
| [ipart](@ref kyosu::ipart ) | [is_denormal](@ref kyosu::is_denormal ) | [is_equal](@ref kyosu::is_equal ) | [is_eqz](@ref kyosu::is_eqz ) | [is_finite](@ref kyosu::is_finite ) |
| [is_infinite](@ref kyosu::is_infinite ) | [is_imag](@ref kyosu::is_imag ) | [is_nan](@ref kyosu::is_nan ) | [is_nez](@ref kyosu::is_nez ) | [is_not_denormal](@ref kyosu::is_not_denormal ) |
| [is_not_equal](@ref kyosu::is_not_equal ) | [is_not_finite](@ref kyosu::is_not_finite ) | [is_not_infinite](@ref kyosu::is_not_finite ) | [is_not_nan](@ref kyosu::is_not_nan ) | [is_not_real](@ref kyosu::is_not_real ) |
Expand All @@ -152,7 +154,8 @@ complex functions and rotation related quaternion usage.
| [lpart](@ref kyosu::lpart ) | [lipart](@ref kyosu::lipart ) | [ljpart](@ref kyosu::ljpart ) | [lkpart](@ref kyosu::lkpart ) | |
| [nearest](@ref kyosu::nearest ) | [oneminus](@ref kyosu::oneminus ) | [pow](@ref kyosu::pow ) | [pow1p](@ref kyosu::pow1p ) | [pow_abs](@ref kyosu::pow_abs ) |
| [powm1](@ref kyosu::powm1 ) | [proj](@ref kyosu::proj ) | [pure](@ref kyosu::imag ) | [radinpi](@ref kyosu::radinpi )| [real](@ref kyosu::real ) |
| [rec](@ref kyosu::rec ) | [reldist](@ref kyosu::reldist ) | [sec](@ref kyosu::sec ) | [secpi](@ref kyosu::secpi ) | [sech](@ref kyosu::sech ) |
| [rec](@ref kyosu::rec ) | [reldist](@ref kyosu::reldist ) | [reverse_horner](@ref kyosu::reverse_horner ) | [right_horner](@ref kyosu::right_horner ) | [right_reverse_horner](@ref kyosu::right_reverse_horner ) |
| [sec](@ref kyosu::sec ) | [secpi](@ref kyosu::secpi ) | [sech](@ref kyosu::sech ) | | |
| [sign](@ref kyosu::sign ) | [sin](@ref kyosu::sin ) | [sinc](@ref kyosu::sinc ) | [sincos](@ref kyosu::sincos ) | [sinpi](@ref kyosu::sinpi ) |
| [sinpicospi](@ref kyosu::sinpicospi ) | [sinh](@ref kyosu::sinh ) | [sinhcosh](@ref kyosu::sinhcosh ) | [slerp](@ref kyosu::slerp ) | [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 ) |
Expand Down
2 changes: 1 addition & 1 deletion include/kyosu/complex/beta.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ namespace kyosu
//! **Return value**
//!
//! 1. If x and y are real typed values returns \f$\displaystyle \mathbf{B}(x,y) = \int_0^1 t^{x-1}(1-t)^{y-1}\mbox{d}t\f$
//! 2. The complex value \f$\displaystyle \mathbb{B}(x,y) = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)}\f$ is returned.
//! 2. if x or y is complex the value \f$\displaystyle \mathbf{B}(x,y) = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)}\f$ is returned.
//!
//! @groupheader{Example}
//!
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/complex/log_abs_gamma.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ namespace kyosu
//! @code
//! namespace kyosu
//! {
//! template<kyosu::concepts::complex T> constexpr T log_abs_gamma(T z) noexcept;
//! template<eve::floating_ordered_value T> constexpr T log_abs_gamma(T z) noexcept;
//! template<kyosu::concepts::complex T> constexpr T log_abs_gamma(T z) noexcept;
//! template<eve::floating_ordered_value T> constexpr as_real_t<T> log_abs_gamma(T z) noexcept;
//! }
//! @endcode
//!
Expand All @@ -66,7 +66,7 @@ namespace kyosu
//!
//! **Return value**
//!
//! Returns \f$\log(|\Gamma(z)|)\f$. If z is floating the result is as if complex(z) was used in the call.
//! Returns \f$\log(|\Gamma(z)|)\f$.
//!
//! @groupheader{Example}
//!
Expand Down
4 changes: 2 additions & 2 deletions include/kyosu/complex/log_gamma.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ namespace kyosu
//! @code
//! namespace kyosu
//! {
//! template<kyosu::concepts::complex T> constexpr T log_gamma(T z) noexcept;
//! template<eve::floating_ordered_value T> constexpr T log_gamma(T z) noexcept;
//! template<kyosu::concepts::complex T> constexpr auto log_gamma(T z) noexcept;
//! template<eve::floating_ordered_value T> constexpr auto log_gamma(T z) noexcept;
//! }
//! @endcode
//!
Expand Down
4 changes: 2 additions & 2 deletions include/kyosu/complex/tgamma.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ namespace kyosu
//! @addtogroup functions
//! @{
//! @var tgamma
//! @brief Computes the tgammaolute value of the parameter.
//! @brief Computes \f$\Gamma(z)\f$r.
//!
//! **Defined in Header**
//!
Expand All @@ -54,7 +54,7 @@ namespace kyosu
//! @code
//! namespace kyosu
//! {
//! template<kyosu::concepts::complex T> constexpr T tgamma(T z) noexcept;
//! template<kyosu::concepts::complex T> constexpr T tgamma(T z) noexcept;
//! template<eve::floating_ordered_value T> constexpr T tgamma(T z) noexcept;
//! }
//! @endcode
Expand Down
16 changes: 16 additions & 0 deletions include/kyosu/functions.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,17 @@
#include <kyosu/functions/expm1.hpp>
#include <kyosu/functions/expmx2.hpp>
#include <kyosu/functions/expx2.hpp>
#include <kyosu/functions/fam.hpp>
#include <kyosu/functions/floor.hpp>
#include <kyosu/functions/fma.hpp>
#include <kyosu/functions/fms.hpp>
#include <kyosu/functions/fnma.hpp>
#include <kyosu/functions/fnms.hpp>
#include <kyosu/functions/frac.hpp>
#include <kyosu/functions/from_polar.hpp>
#include <kyosu/functions/fsm.hpp>
#include <kyosu/functions/hypot.hpp>
#include <kyosu/functions/horner.hpp>
#include <kyosu/functions/if_else.hpp>
#include <kyosu/functions/inc.hpp>
#include <kyosu/functions/ipart.hpp>
Expand Down Expand Up @@ -96,8 +103,14 @@
#include <kyosu/functions/lkpart.hpp>
#include <kyosu/functions/lpnorm.hpp>
#include <kyosu/functions/manhattan.hpp>
#include <kyosu/functions/maxabs.hpp>
#include <kyosu/functions/maxmag.hpp>
#include <kyosu/functions/minabs.hpp>
#include <kyosu/functions/minmag.hpp>
#include <kyosu/functions/minus.hpp>
#include <kyosu/functions/nearest.hpp>
#include <kyosu/functions/negmaxabs.hpp>
#include <kyosu/functions/negminabs.hpp>
#include <kyosu/functions/oneminus.hpp>
#include <kyosu/functions/pow.hpp>
#include <kyosu/functions/pow1p.hpp>
Expand All @@ -108,7 +121,10 @@
#include <kyosu/functions/radinpi.hpp>
#include <kyosu/functions/real.hpp>
#include <kyosu/functions/rec.hpp>
#include <kyosu/functions/right_horner.hpp>
#include <kyosu/functions/right_reverse_horner.hpp>
#include <kyosu/functions/reldist.hpp>
#include <kyosu/functions/reverse_horner.hpp>
#include <kyosu/functions/sec.hpp>
#include <kyosu/functions/secpi.hpp>
#include <kyosu/functions/sech.hpp>
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/abs.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -11,7 +11,7 @@

namespace kyosu::tags
{
struct callable_abs : eve::elementwise
struct callable_abs: eve::elementwise
{
using callable_tag_type = callable_abs;

Expand Down Expand Up @@ -58,7 +58,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/acos.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -13,7 +13,7 @@

namespace kyosu::tags
{
struct callable_acos : eve::elementwise
struct callable_acos: eve::elementwise
{
using callable_tag_type = callable_acos;

Expand Down Expand Up @@ -64,7 +64,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
10 changes: 5 additions & 5 deletions include/kyosu/functions/acosh.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -13,7 +13,7 @@

namespace kyosu::tags
{
struct callable_acosh : eve::elementwise
struct callable_acosh: eve::elementwise
{
using callable_tag_type = callable_acosh;

Expand Down Expand Up @@ -65,7 +65,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand All @@ -76,9 +76,9 @@ namespace kyosu
//! in the interval \f$[0,\pi]\f$ along the real axis.
//!
//! * for every z: kyosu::acosh( [kyosu::conj](@ref kyosu::conj)(z)) == kyosu::conj([kyosu::acosh](@ref kyosu::acosh)(z)
//! * If z is \f$\pm0\f$, the result is \f$+0,\pi/2\f$
//! * If z is \f$\pm0\f$, the result is \f$+0+i\pi/2\f$
//! * If z is \f$x+i\infty\f$ (for any finite x), the result is \f$\infty+i\pi/2\f$
//! * If z is \f$x+i NaN\f$ (for any finite non zero x), the result is \f$NaN+i NaN\f$.
//! * If z is \f$x+i NaN\f$ (for any finite non zero x), the result is \f$NaN+iNaN\f$.
//! * If z is \f$i NaN\f$ the result is \f$NaN+i\pi/2\f$.
//! * If z is \f$-\infty,y\f$ (for any positive finite y), the result is \f$+\infty,\pi\f$
//! * If z is \f$+\infty,y\f$ (for any positive finite y), the result is \f$+\infty+i 0\f$
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/acospi.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -12,7 +12,7 @@

namespace kyosu::tags
{
struct callable_acospi : eve::elementwise
struct callable_acospi: eve::elementwise
{
using callable_tag_type = callable_acospi;

Expand Down Expand Up @@ -63,7 +63,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/acot.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -13,7 +13,7 @@

namespace kyosu::tags
{
struct callable_acot : eve::elementwise
struct callable_acot: eve::elementwise
{
using callable_tag_type = callable_acot;

Expand Down Expand Up @@ -64,7 +64,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
8 changes: 4 additions & 4 deletions include/kyosu/functions/acoth.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -13,7 +13,7 @@

namespace kyosu::tags
{
struct callable_acoth : eve::elementwise
struct callable_acoth: eve::elementwise
{
using callable_tag_type = callable_acoth;

Expand Down Expand Up @@ -65,7 +65,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand All @@ -75,7 +75,7 @@ namespace kyosu
//!
//! 3. Returns \f$(\log(z+1)-\log(z-1))/2 \f$.
//!
///! @groupheader{Example}
//! @groupheader{Example}
//!
//! @godbolt{doc/acoth.cpp}
//! @}
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/acotpi.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -12,7 +12,7 @@

namespace kyosu::tags
{
struct callable_acotpi : eve::elementwise
struct callable_acotpi: eve::elementwise
{
using callable_tag_type = callable_acotpi;

Expand Down Expand Up @@ -63,7 +63,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/acsc.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -13,7 +13,7 @@

namespace kyosu::tags
{
struct callable_acsc : eve::elementwise
struct callable_acsc: eve::elementwise
{
using callable_tag_type = callable_acsc;

Expand Down Expand Up @@ -63,7 +63,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
6 changes: 3 additions & 3 deletions include/kyosu/functions/acsch.hpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//======================================================================================================================
/*
Kyosu - Complex Without Complexes
Copyright : KYOSU Contributors & Maintainers
Copyright: KYOSU Contributors & Maintainers
SPDX-License-Identifier: BSL-1.0
*/
//======================================================================================================================
Expand All @@ -13,7 +13,7 @@

namespace kyosu::tags
{
struct callable_acsch : eve::elementwise
struct callable_acsch: eve::elementwise
{
using callable_tag_type = callable_acsch;

Expand Down Expand Up @@ -64,7 +64,7 @@ namespace kyosu
//!
//! **Parameters**
//!
//! * `z` : Value to process.
//! * `z`: Value to process.
//!
//! **Return value**
//!
Expand Down
Loading