numerical-collection-cpp 0.10.0
A collection of algorithms in numerical analysis implemented in C++
Loading...
Searching...
No Matches
num_collect::functions Namespace Reference

Namespace of special functions. More...

Namespaces

namespace  impl
 Namespace of internal implementations.
 

Classes

class  legendre_roots
 Class of roots of Legendre function. More...
 

Functions

constexpr auto gamma (double x) -> double
 Calculate a value of gamma function.
 
constexpr auto gamma (float x) -> float
 Calculate a value of gamma function.
 
constexpr auto gamma (std::complex< double > x) -> std::complex< double >
 Calculate a value of gamma function.
 
constexpr auto gamma (std::complex< float > x) -> std::complex< float >
 Calculate a value of gamma function.
 
template<base::concepts::real_scalar F, base::concepts::integral I>
constexpr auto legendre (F x, I n) -> F
 Calculate Legendre function.
 
template<base::concepts::real_scalar F, base::concepts::integral I>
constexpr auto legendre_with_diff (F x, I n) -> std::pair< F, F >
 Calculate Legendre function and its differential coefficient.
 
constexpr auto log_gamma (double x) -> double
 Calculate a natural logarithm of a value of gamma function.
 
constexpr auto log_gamma (float x) -> float
 Calculate a natural logarithm of a value of gamma function.
 

Detailed Description

Namespace of special functions.

Function Documentation

◆ gamma() [1/4]

auto num_collect::functions::gamma ( double x) -> double
nodiscardconstexpr

Calculate a value of gamma function.

Parameters
[in]xArgument.
Returns
Value.

Definition at line 51 of file gamma.h.

◆ gamma() [2/4]

auto num_collect::functions::gamma ( float x) -> float
nodiscardconstexpr

Calculate a value of gamma function.

Parameters
[in]xArgument.
Returns
Value.

Definition at line 35 of file gamma.h.

◆ gamma() [3/4]

auto num_collect::functions::gamma ( std::complex< double > x) -> std::complex<double>
nodiscardconstexpr

Calculate a value of gamma function.

Parameters
[in]xArgument.
Returns
Value.

Definition at line 84 of file gamma.h.

◆ gamma() [4/4]

auto num_collect::functions::gamma ( std::complex< float > x) -> std::complex<float>
nodiscardconstexpr

Calculate a value of gamma function.

Parameters
[in]xArgument.
Returns
Value.

Definition at line 67 of file gamma.h.

◆ legendre()

template<base::concepts::real_scalar F, base::concepts::integral I>
auto num_collect::functions::legendre ( F x,
I n ) -> F
constexpr

Calculate Legendre function.

Template Parameters
FType of x (floating-point number).
IType of n (integer).
Parameters
[in]xVariable.
[in]nDegree of the Legendre function.
Returns
Value of n-thLegendre function of x.

Definition at line 44 of file legendre.h.

◆ legendre_with_diff()

template<base::concepts::real_scalar F, base::concepts::integral I>
auto num_collect::functions::legendre_with_diff ( F x,
I n ) -> std::pair<F, F>
constexpr

Calculate Legendre function and its differential coefficient.

Template Parameters
FType of x (floating-point number).
IType of n (integer).
Parameters
[in]xVariable.
[in]nDegree of the Legendre function.
Returns
n-thLegendre function and its differential coefficient of x.

Definition at line 80 of file legendre.h.

◆ log_gamma() [1/2]

auto num_collect::functions::log_gamma ( double x) -> double
nodiscardconstexpr

Calculate a natural logarithm of a value of gamma function.

Parameters
[in]xArgument.
Returns
Value.

Definition at line 111 of file gamma.h.

◆ log_gamma() [2/2]

auto num_collect::functions::log_gamma ( float x) -> float
nodiscardconstexpr

Calculate a natural logarithm of a value of gamma function.

Parameters
[in]xArgument.
Returns
Value.

Definition at line 101 of file gamma.h.