File: test_align_align.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 (354 lines) | stat: -rw-r--r-- 13,313 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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
// ==========================================================================
//                 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.
//
// ==========================================================================

#ifndef TESTS_ALIGN_TEST_ALIGN_ALIGN_H_
#define TESTS_ALIGN_TEST_ALIGN_ALIGN_H_

#include <iostream>
#include <cstdio>
#include <vector>


#include <seqan/sequence.h>
#include <seqan/stream.h>
#include <seqan/align.h>

using namespace std;
using namespace seqan2;


template <typename TAlign>
void testAlignBasics()
{
    TAlign ali1;            //default C'tor
    TAlign const & c_ali1 = ali1;    //const version

    resize(rows(ali1), 2);    //rows

    //add some rows to ali1
    assignSource(row(ali1, 0), "abcdef");
    insertGaps(row(ali1, 0), 2, 3);
    assignSource(row(ali1, 1), "xyz");

    //test copy C'tor
    TAlign ali2(ali1);
    SEQAN_ASSERT(row(ali1, 0) == row(ali2, 0));    //is the same as ali1
    SEQAN_ASSERT(row(ali1, 1) == row(ali2, 1));

//  it is a real copy
//    SEQAN_ASSERT(getObjectId(row(ali1, 0)); == getObjectId(row(ali2, 0));) //(its not a real copy)
//    SEQAN_ASSERT(getObjectId(row(ali1, 1)) == getObjectId(row(ali2, 1));)

    TAlign ali3;
    ali3 = ali1;            //operator =
    SEQAN_ASSERT(row(ali1, 0) == row(ali3, 0));    //is the same as ali1
    SEQAN_ASSERT(row(ali1, 1) == row(ali3, 1));

//  it is a real copy
//    SEQAN_ASSERT(getObjectId(row(ali1, 0)) == getObjectId(row(ali3, 0))) //(its not a real copy)
//    SEQAN_ASSERT(getObjectId(row(ali1, 1)) == getObjectId(row(ali3, 1)))

    detach(ali3);            //detach
    SEQAN_ASSERT(row(ali1, 0) == row(ali3, 0));    //is the same as ali1
    SEQAN_ASSERT(row(ali1, 1) == row(ali3, 1));
//  it is a real copy
//    SEQAN_ASSERT(getObjectId(row(ali1, 0)) != getObjectId(row(ali3, 0))) //ali3 is not dependent anymore
//    SEQAN_ASSERT(getObjectId(row(ali1, 1)) != getObjectId(row(ali3, 1)))

    SEQAN_ASSERT_NOT(dependentSource(row(ali3, 0))); //dependent
    SEQAN_ASSERT_NOT(dependentSource(row(ali3, 1)));

//____________________________________________________________________________
// Test Column Access

    typedef typename Cols<TAlign>::Type TCols;
    typedef typename Cols<TAlign const>::Type TConstCols;
    TCols cols1 = cols(ali1);                //cols
    TConstCols cols2 = cols(c_ali1);        //const version

    typename Col<TAlign>::Type col1 = col(ali1, 0); //col
    SEQAN_ASSERT(col1 == cols1[0]);

    typename Col<TAlign const>::Type c_col1 = col(c_ali1, 0);
    SEQAN_ASSERT(c_col1 == col1);

//____________________________________________________________________________
// Test Rows Access

    typename Rows<TAlign>::Type rows1 = rows(ali1); //rows
    typename Rows<TAlign const>::Type rows2 = rows(c_ali1); //rows

    typename Row<TAlign>::Type row1 = row(ali1, 0); //row
    typename Row<TAlign>::Type row2 = rows1[0];        //rows::operator[]
    typename Row<TAlign const>::Type row3 = rows2[0];

//____________________________________________________________________________

}

//////////////////////////////////////////////////////////////////////////////

template <typename TAlign>
void testAlignColsBase()
{
//____________________________________________________________________________

    TAlign ali1;
    TAlign const & c_ali1 = ali1;
    resize(rows(ali1), 2);
    assignSource(row(ali1, 0), "abcdef");
    insertGaps(row(ali1, 0), 2, 3);
    assignSource(row(ali1, 1), "xyz");

    typedef typename Cols<TAlign>::Type TCols;
    TCols cols1(ali1);                            //special c'tor
    TCols const & c_cols1 = cols1;                //(const version)
    TCols cols2;                                //default c'tor
    TCols cols3 = cols1;                        //copy c'tor
    cols2 = cols1;                                //operator =

    typedef typename Cols<TAlign const>::Type TConstCols;
    TConstCols cols4(c_ali1);                    //special c'tor

    typename Col<TAlign>::Type col1 = cols1[0];    //operator[]
    typename Col<TAlign>::Type const c_col1 = c_cols1[1];
    typename Col<TAlign const>::Type col2 = cols4[1];

    typedef typename Iterator<TCols, Rooted>::Type TColsIterator;
    typedef typename Iterator<TCols const, Rooted>::Type TConstColsIterator;

    TColsIterator col_it1 = begin(cols1);  //begin
    TConstColsIterator const_col_it1 = begin(c_cols1);
    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[beginPosition(cols1)]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[beginPosition(cols1)]);
    SEQAN_ASSERT(value(const_col_it1, 0) == row(ali1, 0)[beginPosition(cols1)]);
    SEQAN_ASSERT(value(const_col_it1, 1) == row(ali1, 1)[beginPosition(cols1)]);

    col_it1 = end(cols1);                        //end
    const_col_it1 = end(c_cols1);
    --col_it1;                                    //operator --
    --const_col_it1;

    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[endPosition(cols1) - 1]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[endPosition(cols1) - 1]);
    SEQAN_ASSERT(value(const_col_it1, 0) == row(ali1, 0)[endPosition(c_cols1) - 1]);
    SEQAN_ASSERT(value(const_col_it1, 1) == row(ali1, 1)[endPosition(c_cols1) - 1]);

    setBeginPosition(row(ali1, 0), 4);
    setBeginPosition(row(ali1, 1), 2);
    SEQAN_ASSERT_EQ(beginPosition(cols(ali1)), 2u); //beginPosition
//____________________________________________________________________________
//     cols iterator

    TColsIterator col_it2;                        //defaut c'tor
    TColsIterator col_it3(ali1);                //special c'tor

    TColsIterator const & c_col_it1 = col_it1;    // (const version, dont confuse with const_col_it1)
        // Test copying, but do not use further.
    TColsIterator const & c_col_it2 = col_it2;
        (void)c_col_it2;

    SEQAN_ASSERT(&host(col_it1) == &ali1);        //host
    SEQAN_ASSERT(&host(c_col_it1) == &ali1);

    setHost(col_it2, ali1);                        //setHost
    SEQAN_ASSERT(&host(col_it2) == &ali1);

    SEQAN_ASSERT(&host(container(col_it1)) == &ali1); //container
    SEQAN_ASSERT(&host(container(c_col_it1)) == &ali1); //container

    col_it1 = begin(cols1);                        //begin
    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[beginPosition(cols1)]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[beginPosition(cols1)]);

    col_it2 = ++col_it1;                        //operator ++ (prefix)
    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it2, 0) == row(ali1, 0)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it2, 1) == row(ali1, 1)[beginPosition(cols1) + 1]);

    col_it2 = col_it1++;                        //operator ++ (suffix)
    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[beginPosition(cols1) + 2]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[beginPosition(cols1) + 2]);
    SEQAN_ASSERT(value(col_it2, 0) == row(ali1, 0)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it2, 1) == row(ali1, 1)[beginPosition(cols1) + 1]);

    col_it2 = --col_it1;                        //operator -- (prefix)
    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it2, 0) == row(ali1, 0)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it2, 1) == row(ali1, 1)[beginPosition(cols1) + 1]);

    col_it2 = col_it1--;                        //operator -- (suffix)
    SEQAN_ASSERT(value(col_it1, 0) == row(ali1, 0)[beginPosition(cols1)]);
    SEQAN_ASSERT(value(col_it1, 1) == row(ali1, 1)[beginPosition(cols1)]);
    SEQAN_ASSERT(value(col_it2, 0) == row(ali1, 0)[beginPosition(cols1) + 1]);
    SEQAN_ASSERT(value(col_it2, 1) == row(ali1, 1)[beginPosition(cols1) + 1]);


    SEQAN_ASSERT_NOT(col_it1 == col_it2);            //operator !=
    SEQAN_ASSERT_NOT(c_col_it1 == col_it2) ;
    SEQAN_ASSERT_NOT(col_it2 == c_col_it1) ;
    SEQAN_ASSERT_NOT(c_col_it1 == c_col_it2)   ;

    --col_it2;

    SEQAN_ASSERT(col_it1 == col_it2);            //operator ==
    SEQAN_ASSERT(c_col_it1 == col_it2);
    SEQAN_ASSERT(col_it2 == c_col_it1);
    SEQAN_ASSERT(c_col_it1 == c_col_it2);


    SEQAN_ASSERT(row(ali1, 0) == "ab---cdef");
    SEQAN_ASSERT_EQ(beginPosition(row(ali1, 0)), 4u);
    col_it1 = iter(cols1, 6);                    //iter

    SEQAN_ASSERT(value(col_it1, 0) == '-');        //value
    SEQAN_ASSERT(value(c_col_it1, 0) == '-');

    --col_it1;
    SEQAN_ASSERT(value(col_it1, 0) == 'b');        //value
    SEQAN_ASSERT(value(c_col_it1, 0) == 'b');

    SEQAN_ASSERT(getValue(col_it1, 0) == 'b');    //getValue
    SEQAN_ASSERT(getValue(c_col_it1, 0) == 'b');

    char c = 'X';
    assignValue(col_it1, 0, 'x');                //assignValue
    SEQAN_ASSERT(row(ali1, 0) == "ax---cdef");
    assignValue(col_it1, 0, c);
    SEQAN_ASSERT(row(ali1, 0) == "aX---cdef");

    c = 'Y';
    assignValue(c_col_it1, 0, 'y');
    SEQAN_ASSERT(row(ali1, 0) == "ay---cdef");
    assignValue(c_col_it1, 0, c);
    SEQAN_ASSERT(row(ali1, 0) == "aY---cdef");


    c = 'X';
    moveValue(col_it1, 0, 'x');                    //moveValue
    SEQAN_ASSERT(row(ali1, 0) == "ax---cdef");
    moveValue(col_it1, 0, c);
    SEQAN_ASSERT(row(ali1, 0) == "aX---cdef");

    c = 'Y';
    moveValue(c_col_it1, 0, 'y');
    SEQAN_ASSERT(row(ali1, 0) == "ay---cdef");
    moveValue(c_col_it1, 0, c);
    SEQAN_ASSERT(row(ali1, 0) == "aY---cdef");


    SEQAN_ASSERT_EQ(length(cols(ali1)), 11u);
}



template <typename TAlign>
void testGotohAlign()
{
    typedef typename Value<TAlign>::Type TValue;

    //align two sequences using Smith-Waterman-algorithm
    String<TValue> str0 = "atgt";
    String<TValue> str1 = "atagat";

    TAlign ali;
    resize(rows(ali), 2);
    assignSource(row(ali, 0), str0);
    assignSource(row(ali, 1), str1);

    Score<int> score_type = Score<int>(1,-1,-1,-1);
    int score = globalAlignment(ali,score_type);

    SEQAN_ASSERT(score == 2);
    SEQAN_ASSERT(row(ali,0) == "at-g-t" );
    SEQAN_ASSERT(row(ali,1) == "atagat" );
    clearGaps(row(ali,0));
    clearGaps(row(ali,1));

    Score<int> score_type1 = Score<int>(1,-1,-1,-3) ;
    score = globalAlignment(ali,score_type1);

    SEQAN_ASSERT(score == -2);
    SEQAN_ASSERT((row(ali,0) == "at--gt") || (row(ali,0) == "atg--t" ));
    SEQAN_ASSERT(row(ali,1) == "atagat" );
}

template <typename TAlign>
void testAlignBasics2()
{
    typedef typename Source<TAlign>::Type TSource;
    StringSet<TSource> ss;
    appendValue(ss, "accagtta");
    appendValue(ss, "ccactagggg");

    TAlign aa(ss);
    cout << ss[0];
    SEQAN_ASSERT(row(aa, 0) == "accagtta");
    SEQAN_ASSERT(getObjectId(row(aa, 0)) == getObjectId(value(ss, 0)));
    SEQAN_ASSERT(row(aa, 1) == "ccactagggg");
    SEQAN_ASSERT(getObjectId(row(aa, 1)) == getObjectId(value(ss, 1)));
}


template <typename TAlign>
void TestAlign_()
{
    testAlignBasics<TAlign>();
    testAlignBasics2<TAlign>();
    testAlignColsBase<TAlign>();
    testGotohAlign<TAlign>();
}


SEQAN_DEFINE_TEST(test_align_align_char_string_array_gaps) {
    TestAlign_<Align<String<char>, ArrayGaps> >();
}


SEQAN_DEFINE_TEST(test_align_align_dna_array_gaps) {
    TestAlign_<Align<String<Dna>, ArrayGaps> >();
}


// SEQAN_DEFINE_TEST(test_align_align_char_string_sumlist_gaps) {
//     TestAlign_<Align<String<char>, SumlistGaps> >();
// }


// SEQAN_DEFINE_TEST(test_align_align_dna_sumlist_gaps) {
//     TestAlign_<Align<String<Dna>, SumlistGaps> >();
// }


#endif