tetration 0.1.6

Chunked tensor .tet format, tet CLI, and optional C ABI (tetration-ffi)
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

//! Little-endian fixed-width primitives shared by layout and catalog.

#[inline]
pub(crate) fn u16_le_at(data: &[u8], i: usize) -> u16 {
    u16::from_le_bytes([data[i], data[i + 1]])
}

#[inline]
pub(crate) fn u32_le_at(data: &[u8], i: usize) -> u32 {
    u32::from_le_bytes([data[i], data[i + 1], data[i + 2], data[i + 3]])
}

#[inline]
pub(crate) fn u64_le_at(data: &[u8], i: usize) -> u64 {
    u64::from_le_bytes([
        data[i],
        data[i + 1],
        data[i + 2],
        data[i + 3],
        data[i + 4],
        data[i + 5],
        data[i + 6],
        data[i + 7],
    ])
}

#[inline]
pub(crate) fn take_u32_le(data: &[u8], cur: &mut usize) -> u32 {
    let v = u32_le_at(data, *cur);
    *cur += 4;
    v
}

#[inline]
pub(crate) fn take_u64_le(data: &[u8], cur: &mut usize) -> u64 {
    let v = u64_le_at(data, *cur);
    *cur += 8;
    v
}

#[inline]
pub(crate) fn put_u16_le(buf: &mut [u8], o: &mut usize, v: u16) {
    buf[*o..*o + 2].copy_from_slice(&v.to_le_bytes());
    *o += 2;
}

#[inline]
pub(crate) fn put_u32_le(buf: &mut [u8], o: &mut usize, v: u32) {
    buf[*o..*o + 4].copy_from_slice(&v.to_le_bytes());
    *o += 4;
}

#[inline]
pub(crate) fn put_u64_le(buf: &mut [u8], o: &mut usize, v: u64) {
    buf[*o..*o + 8].copy_from_slice(&v.to_le_bytes());
    *o += 8;
}

/// Bytes to append so `(len + result) % 8 == 0`.
#[inline]
pub(crate) fn padding_to_align8(len: usize) -> usize {
    (8 - (len % 8)) % 8
}

#[inline]
pub(crate) fn align8_u64(n: u64) -> u64 {
    (n + 7) & !7
}

/// Why a byte span `[offset, offset + len)` does not fit in a container.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum SpanError {
    AddOverflow,
    OutOfBounds { end: u64 },
}

/// Validate `offset + len <= container_len` for a half-open byte span.
pub(crate) fn checked_u64_byte_span(
    offset: u64,
    len: u64,
    container_len: u64,
) -> Result<(), SpanError> {
    let end = offset.checked_add(len).ok_or(SpanError::AddOverflow)?;
    if end > container_len {
        return Err(SpanError::OutOfBounds { end });
    }
    Ok(())
}

/// Half-open subslice range when `offset + len` fits in `container_len`.
pub(crate) fn checked_usize_subslice(
    offset: usize,
    len: usize,
    container_len: usize,
) -> Result<std::ops::Range<usize>, SpanError> {
    let end = offset.checked_add(len).ok_or(SpanError::AddOverflow)?;
    if end > container_len {
        return Err(SpanError::OutOfBounds { end: end as u64 });
    }
    Ok(offset..end)
}