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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
//
// A rust binding for the GSL library by Guillaume Gomez (guillaume1.gomez@gmail.com)
//
//! This following routines compute the gamma and beta functions in their full and incomplete forms, as well as various kinds of factorials.
/// The Gamma function is defined by the following integral,
///
/// \Gamma(x) = \int_0^\infty dt t^{x-1} \exp(-t)
///
/// It is related to the factorial function by \Gamma(n)=(n-1)! for positive integer n.
/// Further information on the Gamma function can be found in Abramowitz & Stegun, Chapter 6.
pub mod gamma {
use ffi;
use std::mem::zeroed;
use enums;
/// These routines compute the Gamma function \Gamma(x), subject to x not being a negative integer or zero. The function is computed using the real Lanczos method.
/// The maximum value of x such that \Gamma(x) is not considered an overflow is given by the macro GSL_SF_GAMMA_XMAX and is 171.0.
pub fn gamma(x: f64) -> f64 {
unsafe { ffi::gsl_sf_gamma(x) }
}
/// This routine provides an exponential function \exp(x) using GSL semantics and error checking.
pub fn gamma_e(x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_gamma_e(x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the Gamma function \Gamma(x), subject to x not being a negative integer or zero.
/// The function is computed using the real Lanczos method. The maximum value of x such that \Gamma(x) is not considered an overflow is given by the macro GSL_SF_GAMMA_XMAX and is 171.0.
pub fn lngamma(x: f64) -> f64 {
unsafe { ffi::gsl_sf_lngamma(x) }
}
/// This routine computes the Gamma function \Gamma(x), subject to x not being a negative integer or zero.
/// The function is computed using the real Lanczos method. The maximum value of x such that \Gamma(x) is not considered an overflow is given by the macro GSL_SF_GAMMA_XMAX and is 171.0.
pub fn lngamma_e(x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lngamma_e(x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the sign of the gamma function and the logarithm of its magnitude, subject to x not being a negative integer or zero.
/// The function is computed using the real Lanczos method.
/// The value of the gamma function and its error can be reconstructed using the relation \Gamma(x) = sgn * \exp(result\_lg), taking into account the two components of result_lg.
pub fn lngamma_sgn_e(x: f64, sgn: &mut f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lngamma_sgn_e(x, &mut result, sgn) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the regulated Gamma Function \Gamma^*(x) for x > 0. The regulated gamma function is given by,
///
/// ```latex
/// \Gamma^*(x) = \Gamma(x)/(\sqrt{2\pi} x^{(x-1/2)} \exp(-x))
///
/// = (1 + (1/12x) + ...) for x to infty
/// ```
///
/// and is a useful suggestion of Temme.
pub fn gammastar(x: f64) -> f64 {
unsafe { ffi::gsl_sf_gammastar(x) }
}
/// This routine computes the regulated Gamma Function \Gamma^*(x) for x > 0. The regulated gamma function is given by,
///
/// ```latex
/// \Gamma^*(x) = \Gamma(x)/(\sqrt{2\pi} x^{(x-1/2)} \exp(-x))
///
/// = (1 + (1/12x) + ...) for x to infty
/// ```
///
/// and is a useful suggestion of Temme.
pub fn gammastar_e(x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_gammastar_e(x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the reciprocal of the gamma function, 1/\Gamma(x) using the real Lanczos method.
pub fn gammainv(x: f64) -> f64 {
unsafe { ffi::gsl_sf_gammainv(x) }
}
/// This routine computes the reciprocal of the gamma function, 1/\Gamma(x) using the real Lanczos method.
pub fn gammainv_e(x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_gammainv_e(x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes \log(\Gamma(z)) for complex z=z_r+i z_i and z not a negative integer or zero, using the complex Lanczos method.
/// The returned parameters are lnr = \log|\Gamma(z)| and arg = \arg(\Gamma(z)) in (-\pi,\pi]. Note that the phase part (arg) is not well-determined when |z| is very large, due to inevitable roundoff in restricting to (-\pi,\pi].
/// This will result in a GSL_ELOSS error when it occurs. The absolute value part (lnr), however, never suffers from loss of precision.
pub fn lngamma_complex_e(zr: f64, zi: f64) -> (enums::Value, ::types::Result, ::types::Result) {
let mut lnr = unsafe { zeroed::<ffi::gsl_sf_result>() };
let mut arg = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lngamma_complex_e(zr, zi, &mut lnr, &mut arg) };
(enums::Value::from(ret), ::types::Result{val: lnr.val, err: lnr.err}, ::types::Result{val: arg.val, err: arg.err})
}
}
/// Although factorials can be computed from the Gamma function, using the relation n! = \Gamma(n+1) for non-negative integer n, it is usually more
/// efficient to call the functions in this section, particularly for small values of n, whose factorial values are maintained in hardcoded tables.
pub mod factorials {
use ffi;
use std::mem::zeroed;
use enums;
/// This routine computes the factorial n!. The factorial is related to the Gamma function by n! = \Gamma(n+1).
/// The maximum value of n such that n! is not considered an overflow is given by the macro SF_FACT_NMAX and is 170.
pub fn fact(n: u32) -> f64 {
unsafe { ffi::gsl_sf_fact(n) }
}
/// This routine computes the factorial n!. The factorial is related to the Gamma function by n! = \Gamma(n+1).
/// The maximum value of n such that n! is not considered an overflow is given by the macro SF_FACT_NMAX and is 170.
pub fn fact_e(n: u32) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_fact_e(n, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the double factorial n!! = n(n-2)(n-4) \dots.
/// The maximum value of n such that n!! is not considered an overflow is given by the macro SF_DOUBLEFACT_NMAX and is 297.
pub fn doublefact(n: u32) -> f64 {
unsafe { ffi::gsl_sf_doublefact(n) }
}
/// This routine computes the double factorial n!! = n(n-2)(n-4) \dots.
/// The maximum value of n such that n!! is not considered an overflow is given by the macro SF_DOUBLEFACT_NMAX and is 297.
pub fn doublefact_e(n: u32) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_doublefact_e(n, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the logarithm of the factorial of n, \log(n!).
/// The algorithm is faster than computing \ln(\Gamma(n+1)) via gsl_sf_lngamma for n < 170, but defers for larger n.
pub fn lnfact(n: u32) -> f64 {
unsafe { ffi::gsl_sf_lnfact(n) }
}
/// This routine computes the logarithm of the factorial of n, \log(n!).
/// The algorithm is faster than computing \ln(\Gamma(n+1)) via gsl_sf_lngamma for n < 170, but defers for larger n.
pub fn lnfact_e(n: u32) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lnfact_e(n, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the logarithm of the double factorial of n, \log(n!!).
pub fn lndoublefact(n: u32) -> f64 {
unsafe { ffi::gsl_sf_lndoublefact(n) }
}
/// This routine computes the logarithm of the double factorial of n, \log(n!!).
pub fn lndoublefact_e(n: u32) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lndoublefact_e(n, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the combinatorial factor n choose m = n!/(m!(n-m)!)
pub fn choose(n: u32, m: u32) -> f64 {
unsafe { ffi::gsl_sf_choose(n, m) }
}
/// This routine computes the combinatorial factor n choose m = n!/(m!(n-m)!)
pub fn choose_e(n: u32, m: u32) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_choose_e(n, m, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the logarithm of n choose m. This is equivalent to the sum \log(n!) - \log(m!) - \log((n-m)!).
pub fn lnchoose(n: u32, m: u32) -> f64 {
unsafe { ffi::gsl_sf_lnchoose(n, m) }
}
/// This routine computes the logarithm of n choose m. This is equivalent to the sum \log(n!) - \log(m!) - \log((n-m)!).
pub fn lnchoose_e(n: u32, m: u32) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lnchoose_e(n, m, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the Taylor coefficient x^n / n! for x >= 0, n >= 0.
pub fn taylorcoeff(n: i32, x: f64) -> f64 {
unsafe { ffi::gsl_sf_taylorcoeff(n, x) }
}
/// This routine computes the Taylor coefficient x^n / n! for x >= 0, n >= 0.
pub fn taylorcoeff_e(n: i32, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_taylorcoeff_e(n, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
}
pub mod pochhammer_symbol {
use ffi;
use std::mem::zeroed;
use enums;
/// This routine computes the Pochhammer symbol (a)_x = \Gamma(a + x)/\Gamma(a).
/// The Pochhammer symbol is also known as the Apell symbol and sometimes written as (a,x).
/// When a and a+x are negative integers or zero, the limiting value of the ratio is returned.
pub fn poch(a: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_poch(a, x) }
}
/// This routine computes the Pochhammer symbol (a)_x = \Gamma(a + x)/\Gamma(a).
/// The Pochhammer symbol is also known as the Apell symbol and sometimes written as (a,x).
/// When a and a+x are negative integers or zero, the limiting value of the ratio is returned.
pub fn poch_e(a: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_poch_e(a, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the logarithm of the Pochhammer symbol, \log((a)_x) = \log(\Gamma(a + x)/\Gamma(a)).
pub fn lnpoch(a: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_lnpoch(a, x) }
}
/// This routine computes the logarithm of the Pochhammer symbol, \log((a)_x) = \log(\Gamma(a + x)/\Gamma(a)).
pub fn lnpoch_e(a: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lnpoch_e(a, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// These routines compute the sign of the Pochhammer symbol and the logarithm of its magnitude.
/// The computed parameters are result = \log(|(a)_x|) with a corresponding error term, and sgn = \sgn((a)_x) where (a)_x = \Gamma(a + x)/\Gamma(a).
pub fn lnpoch_sgn_e(a: f64, x: f64, sgn: &mut f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lnpoch_sgn_e(a, x, &mut result, sgn) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the relative Pochhammer symbol ((a)_x - 1)/x where (a)_x = \Gamma(a + x)/\Gamma(a).
pub fn pochrel(a: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_pochrel(a, x) }
}
/// This routine computes the relative Pochhammer symbol ((a)_x - 1)/x where (a)_x = \Gamma(a + x)/\Gamma(a).
pub fn pochrel_e(a: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_pochrel_e(a, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
}
pub mod beta {
use ffi;
use std::mem::zeroed;
use enums;
/// This routine computes the Beta Function, B(a,b) = \Gamma(a)\Gamma(b)/\Gamma(a+b) subject to a and b not being negative integers.
pub fn beta(a: f64, b: f64) -> f64 {
unsafe { ffi::gsl_sf_beta(a, b) }
}
/// This routine computes the Beta Function, B(a,b) = \Gamma(a)\Gamma(b)/\Gamma(a+b) subject to a and b not being negative integers.
pub fn beta_e(a: f64, b: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_beta_e(a, b, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the logarithm of the Beta Function, \log(B(a,b)) subject to a and b not being negative integers.
pub fn lnbeta(a: f64, b: f64) -> f64 {
unsafe { ffi::gsl_sf_lnbeta(a, b) }
}
/// This routine computes the logarithm of the Beta Function, \log(B(a,b)) subject to a and b not being negative integers.
pub fn lnbeta_e(a: f64, b: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_lnbeta_e(a, b, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
}
pub mod incomplete_gamma {
use ffi;
use std::mem::zeroed;
use enums;
/// This routine computes the unnormalized incomplete Gamma Function \Gamma(a,x) = \int_x^\infty dt t^{a-1} \exp(-t) for a real and x >= 0.
pub fn gamma_inc(a: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_gamma_inc(a, x) }
}
/// This routine computes the unnormalized incomplete Gamma Function \Gamma(a,x) = \int_x^\infty dt t^{a-1} \exp(-t) for a real and x >= 0.
pub fn gamma_inc_e(a: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_gamma_inc_e(a, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the normalized incomplete Gamma Function Q(a,x) = 1/\Gamma(a) \int_x^\infty dt t^{a-1} \exp(-t) for a > 0, x >= 0.
pub fn gamma_inc_Q(a: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_gamma_inc_Q(a, x) }
}
/// This routine computes the normalized incomplete Gamma Function Q(a,x) = 1/\Gamma(a) \int_x^\infty dt t^{a-1} \exp(-t) for a > 0, x >= 0.
pub fn gamma_inc_Q_e(a: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_gamma_inc_Q_e(a, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
/// This routine computes the complementary normalized incomplete Gamma Function P(a,x) = 1 - Q(a,x) = 1/\Gamma(a) \int_0^x dt t^{a-1} \exp(-t) for a > 0, x >= 0.
///
/// Note that Abramowitz & Stegun call P(a,x) the incomplete gamma function (section 6.5).
pub fn gamma_inc_P(a: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_gamma_inc_P(a, x) }
}
/// This routine computes the complementary normalized incomplete Gamma Function P(a,x) = 1 - Q(a,x) = 1/\Gamma(a) \int_0^x dt t^{a-1} \exp(-t) for a > 0, x >= 0.
///
/// Note that Abramowitz & Stegun call P(a,x) the incomplete gamma function (section 6.5).
pub fn gamma_inc_P_e(a: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_gamma_inc_P_e(a, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
}
pub mod incomplete_beta {
use ffi;
use std::mem::zeroed;
use enums;
/// This routine computes the normalized incomplete Beta function I_x(a,b)=B_x(a,b)/B(a,b) where B_x(a,b) = \int_0^x t^{a-1} (1-t)^{b-1} dt for 0 <= x <= 1.
/// For a > 0, b > 0 the value is computed using a continued fraction expansion.
/// For all other values it is computed using the relation I_x(a,b,x) = (1/a) x^a 2F1(a,1-b,a+1,x)/B(a,b).
pub fn beta_inc(a: f64, b: f64, x: f64) -> f64 {
unsafe { ffi::gsl_sf_beta_inc(a, b, x) }
}
/// This routine computes the normalized incomplete Beta function I_x(a,b)=B_x(a,b)/B(a,b) where B_x(a,b) = \int_0^x t^{a-1} (1-t)^{b-1} dt for 0 <= x <= 1.
/// For a > 0, b > 0 the value is computed using a continued fraction expansion.
/// For all other values it is computed using the relation I_x(a,b,x) = (1/a) x^a 2F1(a,1-b,a+1,x)/B(a,b).
pub fn beta_inc_e(a: f64, b: f64, x: f64) -> (enums::Value, ::types::Result) {
let mut result = unsafe { zeroed::<ffi::gsl_sf_result>() };
let ret = unsafe { ffi::gsl_sf_beta_inc_e(a, b, x, &mut result) };
(enums::Value::from(ret), ::types::Result{val: result.val, err: result.err})
}
}