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
//! [`best_available`] — resolves to the fastest [`BitPacker`] implementation for the
//! current compile target.
use crateBitPacker;
use crateScalar;
use crateWasm128;
/// Returns the fastest [`BitPacker`] implementation available for the current compile
/// target: [`Wasm128`](crate::Wasm128) when compiled for `wasm32` with `simd128` enabled,
/// [`Scalar`] otherwise.
///
/// This is a purely compile-time, `cfg`-driven type selection — WASM engines either
/// support `simd128` for the whole module at compile time or they don't, so there is no
/// runtime feature-detection branch to perform (unlike x86 CPUID checks).
///
/// # Examples
///
/// The concrete type behind the returned `impl BitPacker` can't be named directly, so it's
/// used through a small generic helper, same as this crate's own integration tests do:
///
/// ```
/// use wasm_bitpack::{best_available, BitPacker};
///
/// fn round_trip<B: BitPacker>(packer: &B, values: &[u32], num_bits: u8) -> Vec<u32> {
/// let _ = packer;
/// let mut compressed = vec![0u8; B::BLOCK_LEN * num_bits as usize / 8];
/// let written = B::compress(values, &mut compressed, num_bits);
/// let mut decompressed = vec![0u32; B::BLOCK_LEN];
/// B::decompress(&compressed[..written], &mut decompressed, num_bits);
/// decompressed
/// }
///
/// let packer = best_available();
/// let values = vec![9u32; 128];
/// let decompressed = round_trip(&packer, &values, 4);
/// assert_eq!(decompressed, values);
/// ```
/// Returns the fastest [`BitPacker`] implementation available for the current compile
/// target: [`Wasm128`](crate::Wasm128) when compiled for `wasm32` with `simd128` enabled,
/// [`Scalar`] otherwise.
///
/// This is a purely compile-time, `cfg`-driven type selection — WASM engines either
/// support `simd128` for the whole module at compile time or they don't, so there is no
/// runtime feature-detection branch to perform (unlike x86 CPUID checks).
///
/// # Examples
///
/// The concrete type behind the returned `impl BitPacker` can't be named directly, so it's
/// used through a small generic helper, same as this crate's own integration tests do:
///
/// ```
/// use wasm_bitpack::{best_available, BitPacker};
///
/// fn round_trip<B: BitPacker>(packer: &B, values: &[u32], num_bits: u8) -> Vec<u32> {
/// let _ = packer;
/// let mut compressed = vec![0u8; B::BLOCK_LEN * num_bits as usize / 8];
/// let written = B::compress(values, &mut compressed, num_bits);
/// let mut decompressed = vec![0u32; B::BLOCK_LEN];
/// B::decompress(&compressed[..written], &mut decompressed, num_bits);
/// decompressed
/// }
///
/// let packer = best_available();
/// let values = vec![9u32; 128];
/// let decompressed = round_trip(&packer, &values, 4);
/// assert_eq!(decompressed, values);
/// ```