mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Modules | Functions
General Constants
General Mathematics » Constants and units

Constants of general applicability

Modules

 Boost Constants
 Constants provided by the boost library.
 

Functions

template<typename T >
constexpr T mx::math::pi ()
 Get the value of pi. More...
 
template<typename T >
constexpr T mx::math::two_pi ()
 Get the value of 2pi. More...
 
template<typename T >
constexpr T mx::math::half_pi ()
 Get the value of pi/2. More...
 
template<typename T >
constexpr T mx::math::rad2deg ()
 Get the value of 180/pi. More...
 
template<typename T >
constexpr T mx::math::root_two ()
 Get the value of sqrt(2) More...
 
template<typename T >
constexpr T mx::math::ln_two ()
 Get the value of ln(2) More...
 
template<typename T >
constexpr T mx::math::third ()
 Get the value of 1/3. More...
 
template<typename floatT >
constexpr floatT mx::math::five_thirds ()
 Return 5/3 in the specified precision. More...
 
template<typename floatT >
constexpr floatT mx::math::five_sixths ()
 Return 5/6 in the specified precision. More...
 
template<typename floatT >
constexpr floatT mx::math::eleven_thirds ()
 Return 11/3 in the specified precision. More...
 
template<typename floatT >
constexpr floatT mx::math::eleven_sixths ()
 Return 11/6 in the specified precision. More...
 
template<typename floatT >
constexpr floatT mx::math::six_fifths ()
 Return 6/5 in the specified precision. More...
 
template<typename floatT >
constexpr floatT mx::math::three_fifths ()
 Return 3/5 in the specified precision. More...
 
template<typename floatT >
constexpr floatT mx::math::seventeen_thirds ()
 Return 17/3 in the specified precision. More...
 

Function Documentation

◆ eleven_sixths()

template<typename floatT >
constexpr floatT mx::math::eleven_sixths ( )
constexpr

Return 11/6 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 374 of file constants.hpp.

◆ eleven_thirds()

template<typename floatT >
constexpr floatT mx::math::eleven_thirds ( )
constexpr

Return 11/3 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 363 of file constants.hpp.

◆ five_sixths()

template<typename floatT >
constexpr floatT mx::math::five_sixths ( )
constexpr

Return 5/6 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 352 of file constants.hpp.

◆ five_thirds()

template<typename floatT >
constexpr floatT mx::math::five_thirds ( )
constexpr

Return 5/3 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 340 of file constants.hpp.

◆ half_pi()

template<typename T >
constexpr T mx::math::half_pi ( )
constexpr

Get the value of pi/2.

Specializations provided for float, double, long double, and quad (if supported). Can default to boost for other types if MX_INCLUDE_BOOST is defined.

Definition at line 136 of file constants.hpp.

◆ ln_two()

template<typename T >
constexpr T mx::math::ln_two ( )
constexpr

Get the value of ln(2)

Specializations provided for float, double, long double, and quad (if supported). Can default to boost for other types if MX_INCLUDE_BOOST is defined.

Definition at line 263 of file constants.hpp.

◆ pi()

template<typename T >
constexpr T mx::math::pi ( )
constexpr

Get the value of pi.

Specializations provided for float, double, long double, and quad if supported. Can default to boost for other types if MX_INCLUDE_BOOST is defined.

Definition at line 52 of file constants.hpp.

Referenced by mx::AO::constants::calcConstants(), mx::improc::circleOuterpix(), mx::sigproc::window::genCosine(), mx::wfp::fraunhoferPropagator< _wavefrontT >::makeShiftPhase(), mx::sigproc::window::tukey(), mx::sigproc::window::tukey2d(), and mx::sigproc::window::tukey2dAnnulus().

◆ rad2deg()

template<typename T >
constexpr T mx::math::rad2deg ( )
constexpr

Get the value of 180/pi.

Specializations provided for float, double, long double, and quad (if supported). Can default to boost for other types if MX_INCLUDE_BOOST is defined.

Definition at line 178 of file constants.hpp.

◆ root_two()

template<typename T >
constexpr T mx::math::root_two ( )
constexpr

Get the value of sqrt(2)

Specializations provided for float, double, long double, and quad (if supported). Can default to boost for other types if MX_INCLUDE_BOOST is defined.

Definition at line 220 of file constants.hpp.

◆ seventeen_thirds()

template<typename floatT >
constexpr floatT mx::math::seventeen_thirds ( )
constexpr

Return 17/3 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 407 of file constants.hpp.

◆ six_fifths()

template<typename floatT >
constexpr floatT mx::math::six_fifths ( )
constexpr

Return 6/5 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 385 of file constants.hpp.

◆ third()

template<typename T >
constexpr T mx::math::third ( )
constexpr

Get the value of 1/3.

Wrapper for boost constant. Specializations provided for float, double, and long double.

Definition at line 306 of file constants.hpp.

◆ three_fifths()

template<typename floatT >
constexpr floatT mx::math::three_fifths ( )
constexpr

Return 3/5 in the specified precision.

This constant is used frequently in adaptive optics analysis.

Definition at line 396 of file constants.hpp.

◆ two_pi()

template<typename T >
constexpr T mx::math::two_pi ( )
constexpr

Get the value of 2pi.

Specializations provided for float, double, long double, and quad (if supported). Can default to boost for other types if MX_INCLUDE_BOOST is defined.

Definition at line 94 of file constants.hpp.