File: test_alignment_algorithms_dynamic_gap.h

package info (click to toggle)
seqan2 2.5.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 228,748 kB
  • sloc: cpp: 257,602; ansic: 91,967; python: 8,326; sh: 1,056; xml: 570; makefile: 229; awk: 51; javascript: 21
file content (301 lines) | stat: -rw-r--r-- 11,111 bytes parent folder | download
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2026, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Rene Rahn <rene.rahn@fu-berlin.de>
// ==========================================================================
// Unit tests for the global interfaces to test dynamic gap costs.
// ==========================================================================

#ifndef TESTS_ALIGN_TEST_ALIGNMENT_ALGORITHMS_DYNAMIC_GAP_H_
#define TESTS_ALIGN_TEST_ALIGNMENT_ALGORITHMS_DYNAMIC_GAP_H_

#include <seqan/basic.h>
#include <seqan/align.h>

template <typename TAlignment, bool FreeTop, bool FreeLeft, bool FreeRight, bool FreeBottom, typename TACSpec,
          typename TScore>
bool _validateAlignment(TAlignment const & align,
                        seqan2::AlignConfig<FreeTop, FreeLeft, FreeRight, FreeBottom, TACSpec> const & /*conf*/,
                        TScore const & score,
                        seqan2::Score<TScore, seqan2::Simple> const & scoreScheme)
{
    using namespace seqan2;

    typedef typename Row<TAlignment const>::Type TRow;
    typedef typename Iterator<TRow, Standard>::Type TRowIterator;

    SEQAN_ASSERT_EQ(length(row(align,0)), length(row(align, 1)));

    if (length(row(align, 0)) == 0u && length(row(align, 1)) == 0u)
        return true;

    TRowIterator itH = begin(row(align, 0), Standard());
    TRowIterator itV = begin(row(align, 1), Standard());

    bool inGapH = false;
    bool inGapV = false;
    int eScore = 0;
    while (itH != end(row(align, 0), Standard()) && itV != end(row(align, 1), Standard()))
    {
        if (isGap(itH))
        {
            inGapV = false;
            if (!inGapH)
            {
                eScore += scoreGapOpen(scoreScheme);
                inGapH = true;
            }
            else
            {
                eScore += scoreGapExtend(scoreScheme);
            }
        }
        else if (isGap(itV))
        {
            inGapH = false;
            if (!inGapV)
            {
                eScore += scoreGapOpen(scoreScheme);
                inGapV = true;
            }
            else
            {
                eScore += scoreGapExtend(scoreScheme);
            }
        }
        else
        {
            inGapH = false;
            inGapV = false;
            if (*itH == *itV)
                eScore += scoreMatch(scoreScheme);
            else
                eScore += scoreMismatch(scoreScheme);
        }
        ++itH; ++itV;
    }

    // Resolve the begin gaps.
    if (FreeLeft)
    {
        itH = begin(row(align, 0), Standard());
        inGapH = false;
        while (isGap(itH))
        {
            if (inGapH)
                eScore -= scoreGapExtend(scoreScheme);
            else
            {
                inGapH = true;
                eScore -= scoreGapOpen(scoreScheme);
            }
            ++itH;
        }
    }
    if (FreeTop)
    {
        itV = begin(row(align, 1), Standard());
        inGapV = false;
        while (isGap(itV))
        {
            if (inGapV)
                eScore -= scoreGapExtend(scoreScheme);
            else
            {
                inGapV = true;
                eScore -= scoreGapOpen(scoreScheme);
            }
            ++itV;
        }
    }
    if (FreeRight)
    {
        itH = end(row(align, 0), Standard()) - 1;
        inGapH = false;
        while (isGap(itH))
        {
            if (inGapH)
                eScore -= scoreGapExtend(scoreScheme);
            else
            {
                inGapH = true;
                eScore -= scoreGapOpen(scoreScheme);
            }
            --itH;
        }
    }
    if (FreeBottom)
    {
        itV = end(row(align, 1), Standard()) - 1;
        inGapV = false;
        while (isGap(itV))
        {
            if (inGapV)
                eScore -= scoreGapExtend(scoreScheme);
            else
            {
                inGapV = true;
                eScore -= scoreGapOpen(scoreScheme);
            }
            --itV;
        }
    }

    return eScore == score;
}

template <typename TAlign, typename TAlgorithm, typename TAlignConfig>
void testDynamicGapInterfaces(TAlign & alignObj,
                              TAlgorithm const & /*algorithm*/,
                              TAlignConfig const & alignConfig,
                              int lDiag = 0,
                              int uDiag = 0)
{
    using namespace seqan2;

    Score<int, Simple> scoreScheme(2, -2, -1, -4);

    if (IsSameType<TAlgorithm, SmithWaterman>::VALUE)
    {
        ignoreUnusedVariableWarning(alignConfig);
        int score;
        if (lDiag == 0 && uDiag == 0)
            score = localAlignment(alignObj, scoreScheme, DynamicGaps());
        else
            score = localAlignment(alignObj, scoreScheme, lDiag, uDiag, DynamicGaps());
        SEQAN_ASSERT(_validateAlignment(alignObj, alignConfig, score, scoreScheme));

    }
    else
    {
        // search global alignment
        int score;
        if (lDiag == 0 && uDiag == 0)
            score = globalAlignment(alignObj, scoreScheme, alignConfig, DynamicGaps());
        else
            score = globalAlignment(alignObj, scoreScheme, alignConfig, lDiag, uDiag, DynamicGaps());
        SEQAN_ASSERT(_validateAlignment(alignObj, alignConfig, score, scoreScheme));
    }
}

template <typename TAlgorithm, typename TAlignConfig>
void testDynamicGapInterfaces(TAlgorithm const & algo,
                              TAlignConfig const & alignConfig,
                              int lDiag = 0,
                              int uDiag = 0)
{
    using namespace seqan2;

    {
        DnaString str1 = "AAAAACTACGTACGTTTCTGGCCCCC";  // A G T A G C T A C G T A C G T T T C T G G A T G A C
        DnaString str2 = "CCCCCCACGTGTTACGTACGTAAAAA";   // G G T G A C A C G T G T T A C G T A C G T A A
        Align<DnaString> alignObj;
        resize(rows(alignObj), 2);
        assignSource(row(alignObj, 0), str1);
        assignSource(row(alignObj, 1), str2);
        testDynamicGapInterfaces(alignObj, algo, alignConfig, lDiag, uDiag);
    }

    {
        DnaString str1 = "AAAAACTACGTACGTTTCTGGCCCCC";
        DnaString str2 = "CCCCCCACGTGTTACGTACGTAAAAA";
        Align<DnaString> alignObj;
        resize(rows(alignObj), 2);
        assignSource(row(alignObj, 0), str1);
        assignSource(row(alignObj, 1), str2);
        testDynamicGapInterfaces(alignObj, algo, alignConfig, lDiag, uDiag);
    }

    {
        DnaString str1 = "AAAAAGGGGTTTT";
        DnaString str2 = "AAAGTT";
        Align<DnaString> alignObj;
        resize(rows(alignObj), 2);
        assignSource(row(alignObj, 0), str1);
        assignSource(row(alignObj, 1), str2);
        testDynamicGapInterfaces(alignObj, algo, alignConfig, lDiag, uDiag);
    }

    {
        DnaString str1 = "AAAAAATTTTTGGG";
        DnaString str2 = "TTTTTTTTGGGGGGGG";
        Align<DnaString> alignObj;
        resize(rows(alignObj), 2);
        assignSource(row(alignObj, 0), str1);
        assignSource(row(alignObj, 1), str2);
        testDynamicGapInterfaces(alignObj, algo, alignConfig, lDiag, uDiag);
    }


    {
        DnaString str1 = "GGGGCTTTTTTAAAGAGCGCCCTTTTTTGGGG";
        DnaString str2 = "AAAACTTTTTTGGTTTTTTAAAA";
        Align<DnaString> alignObj;
        resize(rows(alignObj), 2);
        assignSource(row(alignObj, 0), str1);
        assignSource(row(alignObj, 1), str2);
        testDynamicGapInterfaces(alignObj, algo, alignConfig, lDiag, uDiag);
    }
}

SEQAN_DEFINE_TEST(test_alignment_algorithms_global_dynamic_cost)
{
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<>());
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<false, true, true, false>());
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<true, false, false, true>());
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<true, true, true, true>());
}

SEQAN_DEFINE_TEST(test_alignment_algorithms_global_dynamic_cost_banded)
{
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<>(), -3, 3);
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<false, true, true, false>(), -3, 3);
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<true, false, false, true>(), -3, 3);
    testDynamicGapInterfaces(seqan2::NeedlemanWunsch(), seqan2::AlignConfig<true, true, true, true>(), -3, 3);
}

SEQAN_DEFINE_TEST(test_alignment_algorithms_local_dynamic_cost)
{
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>());
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>());
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>());
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>());
}

SEQAN_DEFINE_TEST(test_alignment_algorithms_local_dynamic_cost_banded)
{
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>(), -3, 3);
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>(), -3, 3);
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>(), -3, 3);
    testDynamicGapInterfaces(seqan2::SmithWaterman(), seqan2::AlignConfig<>(), -3, 3);
}

#endif // TESTS_ALIGN_TEST_ALIGNMENT_ALGORITHMS_DYNAMIC_GAP_H_