rgsl/
laguerre.rs

1//
2// A rust binding for the GSL library by Guillaume Gomez (guillaume1.gomez@gmail.com)
3//
4
5/*!
6The generalized Laguerre polynomials are defined in terms of confluent hypergeometric functions as L^a_n(x) = ((a+1)_n / n!) 1F1(-n,a+1,x), and are sometimes referred to as the associated Laguerre polynomials.
7They are related to the plain Laguerre polynomials L_n(x) by L^0_n(x) = L_n(x) and L^k_n(x) = (-1)^k (d^k/dx^k) L_(n+k)(x). For more information see Abramowitz & Stegun, Chapter 22.
8!*/
9
10use crate::{types, Value};
11use std::mem::MaybeUninit;
12
13/// This function evaluates the generalized Laguerre polynomials L^a_1(x), L^a_2(x), L^a_3(x) using explicit representations.
14#[doc(alias = "gsl_sf_laguerre_1")]
15pub fn laguerre_1(a: f64, x: f64) -> f64 {
16    unsafe { sys::gsl_sf_laguerre_1(a, x) }
17}
18
19/// This function evaluates the generalized Laguerre polynomials L^a_1(x), L^a_2(x), L^a_3(x) using explicit representations.
20#[doc(alias = "gsl_sf_laguerre_2")]
21pub fn laguerre_2(a: f64, x: f64) -> f64 {
22    unsafe { sys::gsl_sf_laguerre_2(a, x) }
23}
24
25/// This function evaluates the generalized Laguerre polynomials L^a_1(x), L^a_2(x), L^a_3(x) using explicit representations.
26#[doc(alias = "gsl_sf_laguerre_3")]
27pub fn laguerre_3(a: f64, x: f64) -> f64 {
28    unsafe { sys::gsl_sf_laguerre_3(a, x) }
29}
30
31/// This function evaluates the generalized Laguerre polynomials L^a_1(x), L^a_2(x), L^a_3(x) using explicit representations.
32#[doc(alias = "gsl_sf_laguerre_1_e")]
33pub fn laguerre_1_e(a: f64, x: f64) -> Result<types::Result, Value> {
34    let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
35    let ret = unsafe { sys::gsl_sf_laguerre_1_e(a, x, result.as_mut_ptr()) };
36
37    result_handler!(ret, unsafe { result.assume_init() }.into())
38}
39
40/// This function evaluates the generalized Laguerre polynomials L^a_1(x), L^a_2(x), L^a_3(x) using explicit representations.
41#[doc(alias = "gsl_sf_laguerre_2_e")]
42pub fn laguerre_2_e(a: f64, x: f64) -> Result<types::Result, Value> {
43    let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
44    let ret = unsafe { sys::gsl_sf_laguerre_2_e(a, x, result.as_mut_ptr()) };
45
46    result_handler!(ret, unsafe { result.assume_init() }.into())
47}
48
49/// This function evaluates the generalized Laguerre polynomials L^a_1(x), L^a_2(x), L^a_3(x) using explicit representations.
50#[doc(alias = "gsl_sf_laguerre_3_e")]
51pub fn laguerre_3_e(a: f64, x: f64) -> Result<types::Result, Value> {
52    let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
53    let ret = unsafe { sys::gsl_sf_laguerre_3_e(a, x, result.as_mut_ptr()) };
54
55    result_handler!(ret, unsafe { result.assume_init() }.into())
56}
57
58/// the generalized Laguerre polynomials L^a_n(x) for a > -1, n >= 0.
59#[doc(alias = "gsl_sf_laguerre_n")]
60pub fn laguerre_n(n: i32, a: f64, x: f64) -> f64 {
61    unsafe { sys::gsl_sf_laguerre_n(n, a, x) }
62}
63
64/// the generalized Laguerre polynomials L^a_n(x) for a > -1, n >= 0.
65#[doc(alias = "gsl_sf_laguerre_n_e")]
66pub fn laguerre_n_e(n: i32, a: f64, x: f64) -> Result<types::Result, Value> {
67    let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
68    let ret = unsafe { sys::gsl_sf_laguerre_n_e(n, a, x, result.as_mut_ptr()) };
69
70    result_handler!(ret, unsafe { result.assume_init() }.into())
71}