eunomia 0.8.0

Atlas datatype law: the Single Source of Truth for numeric/scalar datatype vocabulary (scalars, complex, packed formats, conversions)
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
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

//! ISA-dispatched unpack functions for low-precision data representations.

use crate::types::{Bf16, Bf4, Bf8, F32, F4, F8};

#[cfg(target_arch = "x86_64")]
use super::arch::{has_avx2, has_avx512bw, has_avx512f};

#[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
use super::unsafe_intrinsics;

#[cfg(not(target_arch = "aarch64"))]
use crate::convert::{widen_finite, widen_finite_high_word, widen_high_word};

/// Unpacks Bf8 elements to Bf16.
#[inline]
pub fn unpack_bf8_to_bf16(packed: &[Bf8], unpacked: &mut [Bf16]) {
    #[cfg(target_arch = "x86_64")]
    {
        if has_avx512bw() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx512::unpack_bf8_to_bf16(packed, unpacked);
            }
            return;
        }
        if has_avx2() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx2::unpack_bf8_to_bf16(packed, unpacked);
            }
            return;
        }
    }
    #[cfg(target_arch = "aarch64")]
    {
        // SAFETY: NEON is baseline on aarch64; the kernel bounds reads/writes
        // to the slice lengths.
        unsafe {
            unsafe_intrinsics::neon::unpack_bf8_to_bf16(packed, unpacked);
        }
        return;
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        let len = packed.len();
        let n = len.min(unpacked.len());
        for i in 0..n {
            unpacked[i] = Bf16(widen_high_word::<5, 2>(u32::from(packed[i].0)));
        }
    }
}

/// Unpacks Bf4 elements to Bf16.
#[inline]
pub fn unpack_bf4_to_bf16(packed: &[Bf4], unpacked: &mut [Bf16]) {
    #[cfg(target_arch = "x86_64")]
    {
        if has_avx512bw() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx512::unpack_bf4_to_bf16(packed, unpacked);
            }
            return;
        }
        if has_avx2() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx2::unpack_bf4_to_bf16(packed, unpacked);
            }
            return;
        }
    }
    #[cfg(target_arch = "aarch64")]
    {
        // SAFETY: NEON is baseline on aarch64; the kernel bounds reads/writes
        // to the slice lengths.
        unsafe {
            unsafe_intrinsics::neon::unpack_bf4_to_bf16(packed, unpacked);
        }
        return;
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        let len = packed.len();
        let n = len.min(unpacked.len());
        for i in 0..n {
            let b = packed[i].0;
            unpacked[i] = Bf16(widen_finite_high_word::<2, 1>(b as u32));
        }
    }
}

/// Unpacks packed 4-bit Bf4 pairs (stored 2 per byte) into a Bf16 slice.
#[inline]
pub fn unpack_bf4_to_bf16_packed(packed: &[u8], unpacked: &mut [Bf16]) {
    #[cfg(target_arch = "x86_64")]
    {
        if has_avx512bw() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx512::unpack_bf4_to_bf16_packed(packed, unpacked);
            }
            return;
        }
        if has_avx2() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx2::unpack_bf4_to_bf16_packed(packed, unpacked);
            }
            return;
        }
    }
    #[cfg(target_arch = "aarch64")]
    {
        // SAFETY: NEON is baseline on aarch64; the kernel bounds reads/writes
        // to the slice lengths.
        unsafe {
            unsafe_intrinsics::neon::unpack_bf4_to_bf16_packed(packed, unpacked);
        }
        return;
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        let len = packed.len();
        let n = len.min(unpacked.len() / 2);
        for i in 0..n {
            let byte = packed[i];
            let b1 = byte & 0x0f;
            let b2 = (byte >> 4) & 0x0f;
            unpacked[2 * i] = Bf16(widen_finite_high_word::<2, 1>(b1 as u32));
            unpacked[2 * i + 1] = Bf16(widen_finite_high_word::<2, 1>(b2 as u32));
        }
    }
}

/// Unpacks F4 elements to F32.
#[inline]
pub fn unpack_f4_to_f32(packed: &[F4], unpacked: &mut [F32]) {
    #[cfg(target_arch = "x86_64")]
    {
        if has_avx512f() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx512::unpack_f4_to_f32(packed, unpacked);
            }
            return;
        }
        if has_avx2() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx2::unpack_f4_to_f32(packed, unpacked);
            }
            return;
        }
    }
    #[cfg(target_arch = "aarch64")]
    {
        // SAFETY: NEON is baseline on aarch64; the kernel bounds reads/writes
        // to the slice lengths.
        unsafe {
            unsafe_intrinsics::neon::unpack_f4_to_f32(packed, unpacked);
        }
        return;
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        let len = packed.len().min(unpacked.len());
        for i in 0..len {
            unpacked[i] = F32(packed[i].to_f32());
        }
    }
}

/// Unpacks packed 4-bit F4 pairs (stored 2 per byte) into an F32 slice.
#[inline]
pub fn unpack_f4_to_f32_packed(packed: &[u8], unpacked: &mut [F32]) {
    #[cfg(target_arch = "x86_64")]
    {
        if has_avx512f() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx512::unpack_f4_to_f32_packed(packed, unpacked);
            }
            return;
        }
        if has_avx2() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx2::unpack_f4_to_f32_packed(packed, unpacked);
            }
            return;
        }
    }
    #[cfg(target_arch = "aarch64")]
    {
        // SAFETY: NEON is baseline on aarch64; the kernel bounds reads/writes
        // to the slice lengths.
        unsafe {
            unsafe_intrinsics::neon::unpack_f4_to_f32_packed(packed, unpacked);
        }
        return;
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        let len = packed.len();
        let n = len.min(unpacked.len() / 2);
        for i in 0..n {
            let byte = packed[i];
            let b1 = byte & 0x0f;
            let b2 = (byte >> 4) & 0x0f;
            unpacked[2 * i] = F32(F4(b1).to_f32());
            unpacked[2 * i + 1] = F32(F4(b2).to_f32());
        }
    }
}

/// Unpacks F8 elements to F32.
#[inline]
pub fn unpack_f8_to_f32(packed: &[F8], unpacked: &mut [F32]) {
    #[cfg(target_arch = "x86_64")]
    {
        if has_avx512f() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx512::unpack_f8_to_f32(packed, unpacked);
            }
            return;
        }
        if has_avx2() {
            // SAFETY: the `has_*` guard above confirms the required AVX ISA is
            // available; the kernel bounds reads/writes to the slice lengths.
            unsafe {
                unsafe_intrinsics::avx2::unpack_f8_to_f32(packed, unpacked);
            }
            return;
        }
    }
    #[cfg(target_arch = "aarch64")]
    {
        // SAFETY: NEON is baseline on aarch64; the kernel bounds reads/writes
        // to the slice lengths.
        unsafe {
            unsafe_intrinsics::neon::unpack_f8_to_f32(packed, unpacked);
        }
        return;
    }
    #[cfg(not(target_arch = "aarch64"))]
    {
        static TABLE_BITS: [u32; 256] = {
            let mut t = [0u32; 256];
            let mut idx = 0;
            while idx < 256 {
                t[idx] = widen_finite::<4, 3>(idx as u32);
                idx += 1;
            }
            t
        };
        let len = packed.len().min(unpacked.len());
        for i in 0..len {
            unpacked[i] = F32(f32::from_bits(TABLE_BITS[packed[i].0 as usize]));
        }
    }
}