Blame doc/specfunc-lambert.rst

Packit 67cb25
.. index::
Packit 67cb25
   single: W function
Packit 67cb25
   single: Lambert function
Packit 67cb25
Packit 67cb25
Lambert's W functions, :math:`W(x)`, are defined to be solutions
Packit 67cb25
of the equation :math:`W(x) \exp(W(x)) = x`. This function has
Packit 67cb25
multiple branches for :math:`x < 0`; however, it has only
Packit 67cb25
two real-valued branches. We define :math:`W_0(x)` to be the
Packit 67cb25
principal branch, where :math:`W > -1` for :math:`x < 0`, and 
Packit 67cb25
:math:`W_{-1}(x)`
Packit 67cb25
to be the other real branch, where
Packit 67cb25
:math:`W < -1` for :math:`x < 0`.  The Lambert functions are
Packit 67cb25
declared in the header file :file:`gsl_sf_lambert.h`.
Packit 67cb25
Packit 67cb25
.. function:: double gsl_sf_lambert_W0 (double x)
Packit 67cb25
              int gsl_sf_lambert_W0_e (double x, gsl_sf_result * result)
Packit 67cb25
Packit 67cb25
   These compute the principal branch of the Lambert W function, :math:`W_0(x)`.
Packit 67cb25
.. exceptions: GSL_EDOM, GSL_EMAXITER
Packit 67cb25
Packit 67cb25
.. function:: double gsl_sf_lambert_Wm1 (double x)
Packit 67cb25
              int gsl_sf_lambert_Wm1_e (double x, gsl_sf_result * result)
Packit 67cb25
Packit 67cb25
   These compute the secondary real-valued branch of the Lambert W function, 
Packit 67cb25
   :math:`W_{-1}(x)`.
Packit 67cb25
.. exceptions: GSL_EDOM, GSL_EMAXITER