nale 0.1.2

Nale is a library that performs profile Hidden Markov Model (PHMM) biological sequence alignment.
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

use crate::log_sum;
use crate::structs::dp_matrix::DpMatrix;
use crate::structs::{Profile, Sequence};
use crate::util::log_add;

pub fn forward(profile: &Profile, target: &Sequence, dp_matrix: &mut impl DpMatrix) -> f32 {
    let end_score: f32 = 0.0;

    // initialize the zero row
    dp_matrix.set_special(0, Profile::SPECIAL_N_IDX, 0.0);
    dp_matrix.set_special(
        0,
        Profile::SPECIAL_B_IDX,
        profile.special_transition_score(Profile::SPECIAL_N_IDX, Profile::SPECIAL_MOVE_IDX),
    );
    dp_matrix.set_special(0, Profile::SPECIAL_E_IDX, -f32::INFINITY);
    dp_matrix.set_special(0, Profile::SPECIAL_C_IDX, -f32::INFINITY);
    dp_matrix.set_special(0, Profile::SPECIAL_J_IDX, -f32::INFINITY);

    for profile_idx in 0..=profile.length {
        dp_matrix.set_insert(0, profile_idx, -f32::INFINITY);
        dp_matrix.set_match(0, profile_idx, -f32::INFINITY);
        dp_matrix.set_delete(0, profile_idx, -f32::INFINITY);
    }

    // main recursion
    for target_idx in 1..=target.length {
        let current_target_character = target.digital_bytes[target_idx];

        dp_matrix.set_insert(target_idx, 0, -f32::INFINITY);
        dp_matrix.set_match(target_idx, 0, -f32::INFINITY);
        dp_matrix.set_delete(target_idx, 0, -f32::INFINITY);
        dp_matrix.set_special(target_idx, Profile::SPECIAL_E_IDX, -f32::INFINITY);

        for profile_idx in 1..profile.length {
            // match state
            dp_matrix.set_match(
                target_idx,
                profile_idx,
                log_sum!(
                    dp_matrix.get_match(target_idx - 1, profile_idx - 1)
                        + profile.transition_score(Profile::MATCH_TO_MATCH_IDX, profile_idx - 1),
                    dp_matrix.get_insert(target_idx - 1, profile_idx - 1)
                        + profile.transition_score(Profile::INSERT_TO_MATCH_IDX, profile_idx - 1),
                    dp_matrix.get_special(target_idx - 1, Profile::SPECIAL_B_IDX)
                        + profile.transition_score(Profile::BEGIN_TO_MATCH_IDX, profile_idx - 1),
                    dp_matrix.get_delete(target_idx - 1, profile_idx - 1)
                        + profile.transition_score(Profile::DELETE_TO_MATCH_IDX, profile_idx - 1)
                ) + profile.match_score(current_target_character as usize, profile_idx),
            );

            // insert state
            dp_matrix.set_insert(
                target_idx,
                profile_idx,
                log_sum!(
                    dp_matrix.get_match(target_idx - 1, profile_idx)
                        + profile.transition_score(Profile::MATCH_TO_INSERT_IDX, profile_idx),
                    dp_matrix.get_insert(target_idx - 1, profile_idx)
                        + profile.transition_score(Profile::INSERT_TO_INSERT_IDX, profile_idx)
                ) + profile.insert_score(current_target_character as usize, profile_idx),
            );

            // delete state
            dp_matrix.set_delete(
                target_idx,
                profile_idx,
                log_sum!(
                    dp_matrix.get_match(target_idx, profile_idx - 1)
                        + profile.transition_score(Profile::MATCH_TO_DELETE_IDX, profile_idx - 1),
                    dp_matrix.get_delete(target_idx, profile_idx - 1)
                        + profile.transition_score(Profile::DELETE_TO_DELETE_IDX, profile_idx - 1)
                ),
            );

            // E state
            dp_matrix.set_special(
                target_idx,
                Profile::SPECIAL_E_IDX,
                log_sum!(
                    dp_matrix.get_match(target_idx, profile_idx) + end_score,
                    dp_matrix.get_delete(target_idx, profile_idx) + end_score,
                    dp_matrix.get_special(target_idx, Profile::SPECIAL_E_IDX)
                ),
            );
        }

        // unrolled match state match[M]
        dp_matrix.set_match(
            target_idx,
            profile.length,
            log_sum!(
                dp_matrix.get_match(target_idx - 1, profile.length - 1)
                    + profile.transition_score(Profile::MATCH_TO_MATCH_IDX, profile.length - 1),
                dp_matrix.get_insert(target_idx - 1, profile.length - 1)
                    + profile.transition_score(Profile::INSERT_TO_MATCH_IDX, profile.length - 1),
                dp_matrix.get_special(target_idx - 1, Profile::SPECIAL_B_IDX)
                    + profile.transition_score(Profile::BEGIN_TO_MATCH_IDX, profile.length - 1),
                dp_matrix.get_delete(target_idx - 1, profile.length - 1)
                    + profile.transition_score(Profile::DELETE_TO_MATCH_IDX, profile.length - 1)
            ) + profile.match_score(current_target_character as usize, profile.length),
        );

        // unrolled insert state insert[M]
        dp_matrix.set_insert(target_idx, profile.length, -f32::INFINITY);

        // unrolled delete state delete[M]
        dp_matrix.set_delete(
            target_idx,
            profile.length,
            log_sum!(
                dp_matrix.get_match(target_idx, profile.length - 1)
                    + profile.transition_score(Profile::MATCH_TO_DELETE_IDX, profile.length - 1),
                dp_matrix.get_delete(target_idx, profile.length - 1)
                    + profile.transition_score(Profile::DELETE_TO_DELETE_IDX, profile.length - 1)
            ),
        );

        // unrolled E state
        dp_matrix.set_special(
            target_idx,
            Profile::SPECIAL_E_IDX,
            log_sum!(
                dp_matrix.get_match(target_idx, profile.length),
                dp_matrix.get_delete(target_idx, profile.length),
                dp_matrix.get_special(target_idx, Profile::SPECIAL_E_IDX)
            ),
        );

        // unrolled J state
        dp_matrix.set_special(
            target_idx,
            Profile::SPECIAL_J_IDX,
            log_sum!(
                dp_matrix.get_special(target_idx - 1, Profile::SPECIAL_J_IDX)
                    + profile.special_transition_score(
                        Profile::SPECIAL_J_IDX,
                        Profile::SPECIAL_LOOP_IDX
                    ),
                dp_matrix.get_special(target_idx, Profile::SPECIAL_E_IDX)
                    + profile.special_transition_score(
                        Profile::SPECIAL_E_IDX,
                        Profile::SPECIAL_LOOP_IDX
                    )
            ),
        );

        // unrolled C state
        dp_matrix.set_special(
            target_idx,
            Profile::SPECIAL_C_IDX,
            log_sum!(
                dp_matrix.get_special(target_idx - 1, Profile::SPECIAL_C_IDX)
                    + profile.special_transition_score(
                        Profile::SPECIAL_C_IDX,
                        Profile::SPECIAL_LOOP_IDX
                    ),
                dp_matrix.get_special(target_idx, Profile::SPECIAL_E_IDX)
                    + profile.special_transition_score(
                        Profile::SPECIAL_E_IDX,
                        Profile::SPECIAL_MOVE_IDX
                    )
            ),
        );

        // unrolled N state
        dp_matrix.set_special(
            target_idx,
            Profile::SPECIAL_N_IDX,
            dp_matrix.get_special(target_idx - 1, Profile::SPECIAL_N_IDX)
                + profile
                    .special_transition_score(Profile::SPECIAL_N_IDX, Profile::SPECIAL_LOOP_IDX),
        );

        // unrolled B state
        dp_matrix.set_special(
            target_idx,
            Profile::SPECIAL_B_IDX,
            log_sum!(
                dp_matrix.get_special(target_idx, Profile::SPECIAL_N_IDX)
                    + profile.special_transition_score(
                        Profile::SPECIAL_N_IDX,
                        Profile::SPECIAL_MOVE_IDX
                    ),
                dp_matrix.get_special(target_idx, Profile::SPECIAL_J_IDX)
                    + profile.special_transition_score(
                        Profile::SPECIAL_J_IDX,
                        Profile::SPECIAL_MOVE_IDX
                    )
            ),
        );
    }

    dp_matrix.get_special(target.length, Profile::SPECIAL_C_IDX)
}