1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//
// A rust binding for the GSL library by Guillaume Gomez (guillaume1.gomez@gmail.com)
//

/*!
Lambert’s W functions, W(x), are defined to be solutions of the equation W(x) \exp(W(x)) = x. This function has multiple branches for x < 0; however, it has only two real-valued branches.
We define W_0(x) to be the principal branch, where W > -1 for x < 0, and W_{-1}(x) to be the other real branch, where W < -1 for x < 0.
!*/

use crate::{types, Value};
use std::mem::MaybeUninit;

/// This computes the principal branch of the Lambert W function, W_0(x).
#[doc(alias = "gsl_sf_lambert_W0")]
pub fn lambert_W0(x: f64) -> f64 {
    unsafe { sys::gsl_sf_lambert_W0(x) }
}

/// This computes the principal branch of the Lambert W function, W_0(x).
#[doc(alias = "gsl_sf_lambert_W0_e")]
pub fn lambert_W0_e(x: f64) -> Result<types::Result, Value> {
    let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
    let ret = unsafe { sys::gsl_sf_lambert_W0_e(x, result.as_mut_ptr()) };

    result_handler!(ret, unsafe { result.assume_init() }.into())
}

/// This computes the secondary real-valued branch of the Lambert W function, W_{-1}(x).
#[doc(alias = "gsl_sf_lambert_Wm1")]
pub fn lambert_Wm1(x: f64) -> f64 {
    unsafe { sys::gsl_sf_lambert_Wm1(x) }
}

/// This computes the secondary real-valued branch of the Lambert W function, W_{-1}(x).
#[doc(alias = "gsl_sf_lambert_Wm1_e")]
pub fn lambert_Wm1_e(x: f64) -> Result<types::Result, Value> {
    let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
    let ret = unsafe { sys::gsl_sf_lambert_Wm1_e(x, result.as_mut_ptr()) };

    result_handler!(ret, unsafe { result.assume_init() }.into())
}