pxfm 0.1.29

Fast and accurate 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

/*
 * // Copyright (c) Radzivon Bartoshyk 7/2025. All rights reserved.
 * //
 * // Redistribution and use in source and binary forms, with or without modification,
 * // are permitted provided that the following conditions are met:
 * //
 * // 1.  Redistributions of source code must retain the above copyright notice, this
 * // list of conditions and the following disclaimer.
 * //
 * // 2.  Redistributions in binary form must reproduce the above copyright notice,
 * // this list of conditions and the following disclaimer in the documentation
 * // and/or other materials provided with the distribution.
 * //
 * // 3.  Neither the name of the copyright holder nor the names of its
 * // contributors may be used to endorse or promote products derived from
 * // this software without specific prior written permission.
 * //
 * // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
use crate::common::f_fmla;
use crate::hyperbolic::asinhf::log_eval;
use crate::polyeval::f_polyeval6;

/// Hyperbolic atan
///
/// Max ULP 0.5
#[inline]
pub fn f_atanhf(x: f32) -> f32 {
    let x_abs = x.to_bits() & 0x7fff_ffff;

    // |x| >= 1.0
    if x_abs >= 0x3F80_0000u32 {
        if x.is_nan() {
            return x;
        }
        // |x| == 1.0
        return if x_abs == 0x3F80_0000u32 {
            if x.is_sign_positive() {
                f32::INFINITY
            } else {
                f32::NEG_INFINITY
            }
        } else {
            f32::NAN
        };
    }

    // |x| < ~0.10
    if x_abs <= 0x3dcc_0000u32 {
        // |x| <= 2^-26
        if x_abs <= 0x3280_0000u32 {
            return if x_abs == 0 {
                x
            } else {
                (x as f64 + f64::from_bits(0x3fd5555555555555) * x as f64 * x as f64 * x as f64)
                    as f32
            };
        }

        let xdbl = x as f64;
        let x2 = xdbl * xdbl;
        // Pure Taylor series.
        let pe = f_polyeval6(
            x2,
            0.0,
            f64::from_bits(0x3fd5555555555555),
            f64::from_bits(0x3fc999999999999a),
            f64::from_bits(0x3fc2492492492492),
            f64::from_bits(0x3fbc71c71c71c71c),
            f64::from_bits(0x3fb745d1745d1746),
        );
        return f_fmla(xdbl, pe, xdbl) as f32;
    }
    let xdbl = x as f64;
    (0.5 * log_eval((xdbl + 1.0) / (xdbl - 1.0))) as f32
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_atanhf() {
        assert_eq!(f_atanhf(0.0), 0.0);
        assert_eq!(f_atanhf(1.0), f32::INFINITY);
        assert!(f_atanhf(-1.5).is_nan());
        assert_eq!(f_atanhf(0.25), 0.25541282);
        assert_eq!(f_atanhf(0.124121), 0.12476436);
    }
}