boost 0.0.5+1.90.0

Rust wrapper for Boost Math
Documentation 
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

//! boost/math/special_functions/jacobi_theta.hpp

use crate::ffi;

/// Jacobi theta function *θ<sub>1</sub>(x, q)*
///
/// Corresponds to `boost::math::jacobi_theta1(x, q)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta1.html>
pub fn jacobi_theta_1(x: f64, q: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta1(x, q) }
}

/// Jacobi theta function *θ<sub>1</sub>(x, τ)*
///
/// Corresponds to `boost::math::jacobi_theta1tau(x, τ)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta1.html>
pub fn jacobi_theta_1_tau(x: f64, tau: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta1tau(x, tau) }
}

/// Jacobi theta function *θ<sub>2</sub>(x, q)*
///
/// Corresponds to `boost::math::jacobi_theta2(x, q)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta2.html>
pub fn jacobi_theta_2(x: f64, q: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta2(x, q) }
}

/// Jacobi theta function *θ<sub>2</sub>(x, τ)*
///
/// Corresponds to `boost::math::jacobi_theta2tau(x, τ)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta2.html>
pub fn jacobi_theta_2_tau(x: f64, tau: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta2tau(x, tau) }
}

/// Jacobi theta function *θ<sub>3</sub>(x, q)*
///
/// Corresponds to `boost::math::jacobi_theta3(x, q)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta3.html>
pub fn jacobi_theta_3(x: f64, q: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta3(x, q) }
}

/// Jacobi theta function *θ<sub>3</sub>(x, τ)*
///
/// Corresponds to `boost::math::jacobi_theta3tau(x, τ)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta3.html>
pub fn jacobi_theta_3_tau(x: f64, tau: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta3tau(x, tau) }
}

/// Jacobi theta function *θ<sub>3</sub>(x, q) - 1*
///
/// Corresponds to `boost::math::jacobi_theta3m1(x, q)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta3.html>
pub fn jacobi_theta_3m1(x: f64, q: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta3m1(x, q) }
}

/// Jacobi theta function *θ<sub>3</sub>(x, τ) - 1*
///
/// Corresponds to `boost::math::jacobi_theta3m1tau(x, τ)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta3.html>
pub fn jacobi_theta_3m1_tau(x: f64, tau: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta3m1tau(x, tau) }
}

/// Jacobi theta function *θ<sub>4</sub>(x, q)*
///
/// Corresponds to `boost::math::jacobi_theta4(x, q)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta4.html>
pub fn jacobi_theta_4(x: f64, q: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta4(x, q) }
}

/// Jacobi theta function *θ<sub>4</sub>(x, τ)*
///
/// Corresponds to `boost::math::jacobi_theta4tau(x, τ)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta4.html>
pub fn jacobi_theta_4_tau(x: f64, tau: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta4tau(x, tau) }
}

/// Jacobi theta function *θ<sub>4</sub>(x, q) - 1*
///
/// Corresponds to `boost::math::jacobi_theta4m1(x, q)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta4.html>
pub fn jacobi_theta_4m1(x: f64, q: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta4m1(x, q) }
}

/// Jacobi theta function *θ<sub>4</sub>(x, τ) - 1*
///
/// Corresponds to `boost::math::jacobi_theta4m1tau(x, τ)` in C++.
/// <https://boost.org/doc/libs/latest/libs/math/doc/html/math_toolkit/jacobi_theta/jacobi_theta4.html>
pub fn jacobi_theta_4m1_tau(x: f64, tau: f64) -> f64 {
    unsafe { ffi::math_jacobi_theta4m1tau(x, tau) }
}

#[cfg(test)]
mod smoketests {
    use super::*;

    #[test]
    fn test_jacobi_theta_1() {
        assert!(jacobi_theta_1(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_1_tau() {
        assert!(jacobi_theta_1_tau(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_2() {
        assert!(jacobi_theta_2(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_2_tau() {
        assert!(jacobi_theta_2_tau(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_3() {
        assert!(jacobi_theta_3(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_3_tau() {
        assert!(jacobi_theta_3_tau(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_3m1() {
        assert!(jacobi_theta_3m1(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_3m1_tau() {
        assert!(jacobi_theta_3m1_tau(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_4() {
        assert!(jacobi_theta_4(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_4_tau() {
        assert!(jacobi_theta_4_tau(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_4m1() {
        assert!(jacobi_theta_4m1(0.5, 0.5).is_finite());
    }

    #[test]
    fn test_jacobi_theta_4m1_tau() {
        assert!(jacobi_theta_4m1_tau(0.5, 0.5).is_finite());
    }
}