mmtf 0.1.1

Macromolecular transmission format (MMTF) decoder and encoder
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

use num_integer::Integer;
use num_traits::{Float, NumCast, PrimInt, ToPrimitive};
use binary_decoder::Interpret;
use binary_decoder;
use encoding::{Delta, IntegerEncoding, RecursiveIndexing, RunLength};
use encode::EncodeError;

/// Delta & Runlength
///
/// Interpret bytes as array of 32-bit signed integers,
/// then run-length decode into array of 32-bit signed integers,
/// then delta decode into array of 32-bit signed integers.
///
/// # Examples
///
/// ```
/// use mmtf::codec::DeltaRunlength;
///
/// let data = [1, 2, 3, 4];
/// let encoded = DeltaRunlength::encode(&data).unwrap();
/// assert_eq!(encoded, vec![0, 0, 0, 1, 0, 0, 0, 4]);
///
/// let decoded = DeltaRunlength::decode(&encoded).unwrap();
/// assert_eq!(decoded, data);
/// ```
#[derive(Debug)]
pub struct DeltaRunlength;

impl DeltaRunlength {
    /// Decode given bytes
    pub fn decode(bytes: &[u8]) -> Result<Vec<i32>, EncodeError> {
        let data: Vec<i32> = binary_decoder::Interpret::from(bytes)?;
        RunLength::decode(&data)
            .and_then(|v| Delta::decode(&v))
            .and_then(Ok)
    }

    /// Encode any array of 'T' where `T ` can be any Integer.
    pub fn encode<T>(value: &[T]) -> Result<Vec<u8>, EncodeError>
    where
        T: Integer + NumCast + PrimInt + ToPrimitive,
    {
        Delta::encode(value)
            .and_then(|v| RunLength::encode(&v))
            .and_then(|v| {
                let result: Vec<u8> = Interpret::from(&v[..])?;
                Ok(result)
            })
    }
}

/// Integer & Runlength encoded 32-bit floating-point number array
///
/// Interpret bytes as array of 32-bit signed integers,
/// then run-length decode into array of 32-bit signed integers, then
/// integer decode into array of 32-bit floating-point numbers using
/// the divisor parameter.
///
/// # Examples
///
/// ```
/// use mmtf::codec::IntegerRunLength;
///
/// let data = [1.00, 1.00, 1.00, 1.00, 0.50, 0.50];
/// let encoded = IntegerRunLength::encode(&data, 100).unwrap();
/// assert_eq!(encoded, vec![0, 0, 0, 100, 0, 0, 0, 4, 0, 0, 0, 50, 0, 0, 0, 2]);
///
/// let decoded = IntegerRunLength::decode(&encoded, 100).unwrap();
/// assert_eq!(decoded, data);
/// ```
#[derive(Debug)]
pub struct IntegerRunLength;

impl IntegerRunLength {
    /// Decode given bytes
    pub fn decode(bytes: &[u8], factor: i32) -> Result<Vec<f32>, EncodeError> {
        let data: Vec<i32> = binary_decoder::Interpret::from(bytes)?;
        RunLength::decode(&data)
            .and_then(|v| IntegerEncoding::decode(&v, factor))
            .and_then(Ok)
    }

    /// Encode any array of 'T' where `T ` can be any Float.
    pub fn encode<T>(value: &[T], factor: i32) -> Result<Vec<u8>, EncodeError>
    where
        T: Float + NumCast,
    {
        IntegerEncoding::encode(value, factor)
            .and_then(|v| RunLength::encode(&v))
            .and_then(|v| {
                let result: Vec<u8> = Interpret::from(&v[..])?;
                Ok(result)
            })
    }
}

/// Integer & delta encoded & two-byte-packed 32-bit floating-point number array
///
/// Description Interpret bytes as array of 16-bit signed integers, then unpack
/// into array of 32-bit integers, then delta decode into array of 32-bit integers,
/// then integer decode into array of 32-bit floating-point numbers using the divisor
/// parameter.
///
/// # Examples
///
/// ```
/// use mmtf::codec::IntegerDeltaRecursive;
///
/// let data = [182.00, 182.00, 182.03];
/// let encoded = IntegerDeltaRecursive::encode(&data, 100).unwrap();
/// assert_eq!(encoded, vec![71, 24, 0, 0, 0, 3]);
///
/// let decoded = IntegerDeltaRecursive::decode(&encoded, 100).unwrap();
/// assert_eq!(decoded, data);
/// ```
#[derive(Debug)]
pub struct IntegerDeltaRecursive;

impl IntegerDeltaRecursive {
    /// Decode given bytes
    pub fn decode(bytes: &[u8], factor: i32) -> Result<Vec<f32>, EncodeError> {
        let data: Vec<i16> = binary_decoder::Interpret::from(bytes)?;

        RecursiveIndexing::decode(&data)
            .and_then(|v| Delta::decode(&v))
            .and_then(|v| IntegerEncoding::decode(&v, factor))
            .and_then(Ok)
    }

    /// Encode any array of 'T' where `T ` can be any Float.
    pub fn encode<T>(value: &[T], factor: i32) -> Result<Vec<u8>, EncodeError>
    where
        T: Float + NumCast,
    {
        IntegerEncoding::encode(value, factor)
            .and_then(|v| Delta::encode(&v))
            .and_then(|v| RecursiveIndexing::encode(&v))
            .and_then(|v| {
                let result: Vec<u8> = Interpret::from(&v[..])?;
                Ok(result)
            })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_decode_delta_run_length() {
        let data = [
            0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 3, 0, 0, 0, 2, 0, 0, 0, 1, 0, 0, 0, 0, 0,
            0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 5, 255, 255, 255, 245, 0, 0, 0, 1,
        ];
        let expected = vec![0, 1, 2, 3, 5, 5, 6, 7, 8, 9, 10, -1];
        let actual = DeltaRunlength::decode(&data).unwrap();
        assert_eq!(expected, actual);
    }

    #[test]
    fn it_encode_delta_run_length() {
        let data = [0, 1, 2, 3, 5, 5, 6, 7, 8, 9, 10, -1];
        let expected = vec![
            0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 3, 0, 0, 0, 2, 0, 0, 0, 1, 0, 0, 0, 0, 0,
            0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 5, 255, 255, 255, 245, 0, 0, 0, 1,
        ];
        let actual = DeltaRunlength::encode(&data).unwrap();
        assert_eq!(expected, actual);
    }

    #[test]
    fn it_decode_integer_delta_run_length() {
        let data = [0, 0, 0, 100, 0, 0, 0, 4, 0, 0, 0, 50, 0, 0, 0, 2];
        let expected = vec![1.00, 1.00, 1.00, 1.00, 0.50, 0.50];
        let actual = IntegerRunLength::decode(&data, 100).unwrap();
        assert_eq!(expected, actual);
    }

    #[test]
    fn it_encode_integer_delta_run_length() {
        let data = [1.00, 1.00, 1.00, 1.00, 0.50, 0.50];
        let expected = vec![0, 0, 0, 100, 0, 0, 0, 4, 0, 0, 0, 50, 0, 0, 0, 2];
        let actual = IntegerRunLength::encode(&data, 100).unwrap();
        assert_eq!(expected, actual);
    }

    #[test]
    fn it_decode_integer_delta_recursive() {
        let data = [71, 24, 0, 0, 0, 2, 255, 255, 0, 100, 255, 253, 0, 5];
        let expected = vec![182.00, 182.00, 182.02, 182.01, 183.01, 182.98, 183.03];
        let actual = IntegerDeltaRecursive::decode(&data, 100).unwrap();
        assert_eq!(expected, actual);
    }

    #[test]
    fn it_encode_integer_delta_recursive() {
        let data = [182.00, 182.00, 182.02, 182.01, 183.01, 182.98, 183.03];
        let expected = vec![71, 24, 0, 0, 0, 2, 255, 255, 0, 100, 255, 253, 0, 5];
        let actual = IntegerDeltaRecursive::encode(&data, 100).unwrap();
        assert_eq!(expected, actual);
    }
}