libm/math/
log2f.rs

1/* origin: FreeBSD /usr/src/lib/msun/src/e_log2f.c */
2/*
3 * ====================================================
4 * Copyright (C) 1993 by Sun Microsystems, Inc. All rights reserved.
5 *
6 * Developed at SunPro, a Sun Microsystems, Inc. business.
7 * Permission to use, copy, modify, and distribute this
8 * software is freely granted, provided that this notice
9 * is preserved.
10 * ====================================================
11 */
12/*
13 * See comments in log2.c.
14 */
15
16use core::f32;
17
18const IVLN2HI: f32 = 1.4428710938e+00; /* 0x3fb8b000 */
19const IVLN2LO: f32 = -1.7605285393e-04; /* 0xb9389ad4 */
20/* |(log(1+s)-log(1-s))/s - Lg(s)| < 2**-34.24 (~[-4.95e-11, 4.97e-11]). */
21const LG1: f32 = 0.66666662693; /* 0xaaaaaa.0p-24 */
22const LG2: f32 = 0.40000972152; /* 0xccce13.0p-25 */
23const LG3: f32 = 0.28498786688; /* 0x91e9ee.0p-25 */
24const LG4: f32 = 0.24279078841; /* 0xf89e26.0p-26 */
25
26/// The base 2 logarithm of `x` (f32).
27#[cfg_attr(all(test, assert_no_panic), no_panic::no_panic)]
28pub fn log2f(mut x: f32) -> f32 {
29    let x1p25f = f32::from_bits(0x4c000000); // 0x1p25f === 2 ^ 25
30
31    let mut ui: u32 = x.to_bits();
32    let hfsq: f32;
33    let f: f32;
34    let s: f32;
35    let z: f32;
36    let r: f32;
37    let w: f32;
38    let t1: f32;
39    let t2: f32;
40    let mut hi: f32;
41    let lo: f32;
42    let mut ix: u32;
43    let mut k: i32;
44
45    ix = ui;
46    k = 0;
47    if ix < 0x00800000 || (ix >> 31) > 0 {
48        /* x < 2**-126  */
49        if ix << 1 == 0 {
50            return -1. / (x * x); /* log(+-0)=-inf */
51        }
52        if (ix >> 31) > 0 {
53            return (x - x) / 0.0; /* log(-#) = NaN */
54        }
55        /* subnormal number, scale up x */
56        k -= 25;
57        x *= x1p25f;
58        ui = x.to_bits();
59        ix = ui;
60    } else if ix >= 0x7f800000 {
61        return x;
62    } else if ix == 0x3f800000 {
63        return 0.;
64    }
65
66    /* reduce x into [sqrt(2)/2, sqrt(2)] */
67    ix += 0x3f800000 - 0x3f3504f3;
68    k += (ix >> 23) as i32 - 0x7f;
69    ix = (ix & 0x007fffff) + 0x3f3504f3;
70    ui = ix;
71    x = f32::from_bits(ui);
72
73    f = x - 1.0;
74    s = f / (2.0 + f);
75    z = s * s;
76    w = z * z;
77    t1 = w * (LG2 + w * LG4);
78    t2 = z * (LG1 + w * LG3);
79    r = t2 + t1;
80    hfsq = 0.5 * f * f;
81
82    hi = f - hfsq;
83    ui = hi.to_bits();
84    ui &= 0xfffff000;
85    hi = f32::from_bits(ui);
86    lo = f - hi - hfsq + s * (hfsq + r);
87    (lo + hi) * IVLN2LO + lo * IVLN2HI + hi * IVLN2HI + k as f32
88}