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
//! CRAM record field resolvers.

use std::io;

use noodles_core::Position;
use noodles_fasta as fasta;

use super::{
    feature::substitution::{self, Base as SubstitutionBase},
    Feature, Features, QualityScores, Sequence,
};
use crate::data_container::compression_header::SubstitutionMatrix;

pub(crate) fn resolve_bases(
    reference_sequence: Option<&fasta::record::Sequence>,
    substitution_matrix: &SubstitutionMatrix,
    features: &Features,
    alignment_start: Position,
    read_length: usize,
    buf: &mut Sequence,
) -> io::Result<()> {
    buf.as_mut().clear();
    buf.as_mut().resize(read_length, b'N');

    let mut it = features.with_positions(alignment_start);

    let (mut last_reference_position, mut last_read_position) = it.positions();

    while let Some(((reference_position, read_position), feature)) = it.next() {
        if let Some(reference_sequence) = reference_sequence {
            let dst = &mut buf[last_read_position..read_position];
            let src = &reference_sequence[last_reference_position..reference_position];
            copy_from_bases(dst, src);
        } else if read_position != last_read_position {
            return Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "cannot resolve bases without reference sequence",
            ));
        }

        match feature {
            Feature::Bases(_, bases) => copy_from_bases(&mut buf[read_position..], bases),
            Feature::Scores(..) => {}
            Feature::ReadBase(_, base, _) => buf[read_position] = *base,
            Feature::Substitution(_, substitution::Value::Code(code)) => {
                if let Some(reference_sequence) = reference_sequence {
                    let base = reference_sequence[reference_position];
                    let reference_base = SubstitutionBase::try_from(base).unwrap_or_default();
                    let read_base = substitution_matrix.get(reference_base, *code);
                    buf[read_position] = u8::from(read_base);
                } else {
                    return Err(io::Error::new(
                        io::ErrorKind::InvalidData,
                        "cannot resolve base substitution without reference sequence",
                    ));
                }
            }
            Feature::Substitution(_, substitution::Value::Bases(..)) => {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidData,
                    "cannot resolve base substitution with bases",
                ))
            }
            Feature::Insertion(_, bases) => copy_from_bases(&mut buf[read_position..], bases),
            Feature::Deletion(..) => {}
            Feature::InsertBase(_, base) => buf[read_position] = *base,
            Feature::QualityScore(..) => {}
            Feature::ReferenceSkip(..) => {}
            Feature::SoftClip(_, bases) => copy_from_bases(&mut buf[read_position..], bases),
            Feature::Padding(..) => {}
            Feature::HardClip(..) => {}
        }

        let (next_reference_position, next_read_position) = it.positions();
        last_reference_position = next_reference_position;
        last_read_position = next_read_position;
    }

    if let Some(reference_sequence) = reference_sequence {
        let dst = &mut buf[last_read_position..];

        let end = last_reference_position
            .checked_add(dst.len())
            .expect("attempt to add with overflow");
        let src = &reference_sequence[last_reference_position..end];

        copy_from_bases(dst, src);
    } else if buf[..last_read_position].len() != buf.len() {
        return Err(io::Error::new(
            io::ErrorKind::InvalidData,
            "cannot resolve bases without reference sequence",
        ));
    }

    Ok(())
}

fn copy_from_bases(dst: &mut [u8], src: &[u8]) {
    for (&base, b) in src.iter().zip(dst.iter_mut()) {
        *b = base;
    }
}

/// Resolves the quality scores.
pub fn resolve_quality_scores(
    features: &[Feature],
    read_len: usize,
    quality_scores: &mut QualityScores,
) {
    quality_scores.as_mut().clear();
    quality_scores.as_mut().resize(read_len, 0);

    for feature in features {
        let read_position = feature.position();

        match feature {
            Feature::Scores(_, scores) => {
                let end = read_position
                    .checked_add(scores.len())
                    .expect("attempt to add with overflow");

                quality_scores[read_position..end].copy_from_slice(scores);
            }
            Feature::ReadBase(_, _, score) => quality_scores[read_position] = *score,
            Feature::QualityScore(_, score) => quality_scores[read_position] = *score,
            _ => continue,
        }
    }
}

#[cfg(test)]
mod tests {
    use noodles_core::Position;

    use super::*;

    #[test]
    fn test_resolve_bases() -> Result<(), Box<dyn std::error::Error>> {
        let reference_sequence = fasta::record::Sequence::from(b"ACGTACGT".to_vec());
        let substitution_matrix = Default::default();
        let alignment_start = Position::try_from(1)?;

        let t = |features: &Features, expected: &Sequence| {
            let mut actual = Sequence::default();

            resolve_bases(
                Some(&reference_sequence),
                &substitution_matrix,
                features,
                alignment_start,
                4,
                &mut actual,
            )?;

            assert_eq!(&actual, expected);

            Ok::<_, io::Error>(())
        };

        t(&Features::default(), &Sequence::from(b"ACGT"))?;
        t(
            &Features::from(vec![Feature::Bases(
                Position::try_from(1)?,
                vec![b'T', b'G'],
            )]),
            &Sequence::from(b"TGGT"),
        )?;
        t(
            &Features::from(vec![Feature::ReadBase(Position::try_from(2)?, b'Y', 0)]),
            &Sequence::from(b"AYGT"),
        )?;
        t(
            &Features::from(vec![Feature::Substitution(
                Position::try_from(2)?,
                substitution::Value::Code(1),
            )]),
            &Sequence::from(b"AGGT"),
        )?;
        t(
            &Features::from(vec![Feature::Insertion(
                Position::try_from(2)?,
                vec![b'G', b'G'],
            )]),
            &Sequence::from(b"AGGC"),
        )?;
        t(
            &Features::from(vec![Feature::Deletion(Position::try_from(2)?, 2)]),
            &Sequence::from(b"ATAC"),
        )?;
        t(
            &Features::from(vec![Feature::InsertBase(Position::try_from(2)?, b'G')]),
            &Sequence::from(b"AGCG"),
        )?;
        t(
            &Features::from(vec![Feature::ReferenceSkip(Position::try_from(2)?, 2)]),
            &Sequence::from(b"ATAC"),
        )?;
        t(
            &Features::from(vec![Feature::SoftClip(
                Position::try_from(3)?,
                vec![b'G', b'G'],
            )]),
            &Sequence::from(b"ACGG"),
        )?;
        t(
            &Features::from(vec![Feature::Padding(Position::try_from(1)?, 2)]),
            &Sequence::from(b"ACGT"),
        )?;
        t(
            &Features::from(vec![Feature::HardClip(Position::try_from(1)?, 2)]),
            &Sequence::from(b"ACGT"),
        )?;

        let features = Features::from(vec![Feature::Substitution(
            Position::try_from(2)?,
            substitution::Value::Bases(SubstitutionBase::A, SubstitutionBase::C),
        )]);
        let mut actual = Sequence::default();
        assert!(matches!(
            resolve_bases(
                Some(&reference_sequence),
                &substitution_matrix,
                &features,
                alignment_start,
                4,
                &mut actual,
            ),
            Err(e) if e.kind() == io::ErrorKind::InvalidData
        ));

        Ok(())
    }

    #[test]
    fn test_resolve_bases_without_a_reference_sequence() -> Result<(), Box<dyn std::error::Error>> {
        let substitution_matrix = SubstitutionMatrix::default();
        let features = Features::from(vec![Feature::Bases(
            Position::try_from(1)?,
            vec![b'N', b'N', b'N', b'N'],
        )]);
        let alignment_start = Position::try_from(1)?;

        let mut actual = Sequence::default();
        resolve_bases(
            None,
            &substitution_matrix,
            &features,
            alignment_start,
            4,
            &mut actual,
        )?;
        let expected = Sequence::from(b"NNNN");

        assert_eq!(actual, expected);

        Ok(())
    }

    #[test]
    fn test_resolve_quality_scores() -> Result<(), Box<dyn std::error::Error>> {
        let features = [
            Feature::ReadBase(Position::try_from(1)?, b'A', 5),
            Feature::QualityScore(Position::try_from(3)?, 8),
            Feature::Scores(Position::try_from(5)?, vec![13, 21]),
        ];

        let mut quality_scores = QualityScores::default();
        resolve_quality_scores(&features, 6, &mut quality_scores);
        let expected = QualityScores::from(vec![5, 0, 8, 0, 13, 21]);
        assert_eq!(quality_scores, expected);

        Ok(())
    }
}