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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
// ==========================================================================
// SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2018, 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>
// ==========================================================================
#ifndef SEQAN_INCLUDE_SEQAN_ALIGN_DP_SETUP_H_
#define SEQAN_INCLUDE_SEQAN_ALIGN_DP_SETUP_H_
namespace seqan {
// ============================================================================
// Forwards
// ============================================================================
// ============================================================================
// Tags, Classes, Enums
// ============================================================================
// ============================================================================
// Metafunctions
// ============================================================================
// ----------------------------------------------------------------------------
// SubstituteAlignConfig_
// ----------------------------------------------------------------------------
template <typename TAlignConfig>
struct SubstituteAlignConfig_;
// 0000
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, false, false, false, TSpec> >
{
typedef FreeEndGaps_<False, False, False, False> Type;
};
// 0001
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, false, false, true, TSpec> >
{
typedef FreeEndGaps_<False, False, True, False> Type;
};
// 0010
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, false, true, false, TSpec> >
{
typedef FreeEndGaps_<False, False, False, True> Type;
};
// 0011
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, false, true, true, TSpec> >
{
typedef FreeEndGaps_<False, False, True, True> Type;
};
// 0100
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, true, false, false, TSpec> >
{
typedef FreeEndGaps_<False, True, False, False> Type;
};
// 0101
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, true, false, true, TSpec> >
{
typedef FreeEndGaps_<False, True, True, False> Type;
};
// 0110
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, true, true, false, TSpec> >
{
typedef FreeEndGaps_<False, True, False, True> Type;
};
// 0111
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<false, true, true, true, TSpec> >
{
typedef FreeEndGaps_<False, True, True, True> Type;
};
// 1000
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, false, false, false, TSpec> >
{
typedef FreeEndGaps_<True, False, False, False> Type;
};
// 1001
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, false, false, true, TSpec> >
{
typedef FreeEndGaps_<True, False, True, False> Type;
};
// 1010
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, false, true, false, TSpec> >
{
typedef FreeEndGaps_<True, False, False, True> Type;
};
// 1011
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, false, true, true, TSpec> >
{
typedef FreeEndGaps_<True, False, True, True> Type;
};
// 1100
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, true, false, false, TSpec> >
{
typedef FreeEndGaps_<True, True, False, False> Type;
};
// 1101
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, true, false, true, TSpec> >
{
typedef FreeEndGaps_<True, True, True, False> Type;
};
// 1110
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, true, true, false, TSpec> >
{
typedef FreeEndGaps_<True, True, False, True> Type;
};
// 1111
template <typename TSpec>
struct SubstituteAlignConfig_<AlignConfig<true, true, true, true, TSpec> >
{
typedef FreeEndGaps_<True, True, True, True> Type;
};
// ----------------------------------------------------------------------------
// Metafunction SubstituteAlgoTag_
// ----------------------------------------------------------------------------
// NOTE(rmaerker): Needed to substitute the global alingment algo tags to the correct gap model.
template <typename TTag>
struct SubstituteAlgoTag_
{
typedef TTag Type;
};
template <>
struct SubstituteAlgoTag_<NeedlemanWunsch>
{
typedef LinearGaps Type;
};
template <>
struct SubstituteAlgoTag_<Gotoh>
{
typedef AffineGaps Type;
};
// ----------------------------------------------------------------------------
// SetUpAlignmentProfile
// ----------------------------------------------------------------------------
template <typename TDPType, typename TAlignConfig, typename TTraceSwitch, typename TGapCosts>
struct SetupAlignmentProfile_;
// Profile for Needleman-Wunsch algorithm.
template <typename TFreeEndGaps, typename TGapCosts, typename TTraceSwitch>
struct SetupAlignmentProfile_<DPGlobal, TFreeEndGaps, TGapCosts, TTraceSwitch>
{
typedef DPProfile_<GlobalAlignment_<TFreeEndGaps>, TGapCosts, TTraceSwitch, Serial> Type;
};
// Profile for Smith-Waterman algorithm.
template <typename TFreeEndGaps, typename TGapCosts, typename TTraceSwitch>
struct SetupAlignmentProfile_<DPLocal, TFreeEndGaps, TGapCosts, TTraceSwitch>
{
typedef DPProfile_<LocalAlignment_<>, TGapCosts, TTraceSwitch, Serial> Type;
};
// Profile for Waterman-Eggert algorithm
template <typename TFreeEndGaps, typename TGapCosts, typename TTraceSwitch>
struct SetupAlignmentProfile_<DPLocalEnumerate, TFreeEndGaps, TGapCosts, TTraceSwitch>
{
typedef DPProfile_<LocalAlignment_<SuboptimalAlignment>, TGapCosts, TracebackOn<TracebackConfig_<SingleTrace, GapsLeft> >, Serial> Type;
};
// ============================================================================
// Functions
// ============================================================================
// ----------------------------------------------------------------------------
// Function _usesAffineGaps()
// ----------------------------------------------------------------------------
template <typename TScoringScheme, typename TSeqH, typename TSeqV>
inline bool
_usesAffineGaps(TScoringScheme const & scoringScheme,
TSeqH const & seqH,
TSeqV const & seqV)
{
typedef typename SequenceEntryForScore<TScoringScheme, TSeqH>::Type TSequenceHEntry;
typedef typename SequenceEntryForScore<TScoringScheme, TSeqV>::Type TSequenceVEntry;
TSequenceHEntry seqHEntry = sequenceEntryForScore(scoringScheme, seqH, 0);
TSequenceVEntry seqVEntry = sequenceEntryForScore(scoringScheme, seqV, 0);
return (scoreGapExtendHorizontal(scoringScheme, seqHEntry, seqVEntry) !=
scoreGapOpenHorizontal(scoringScheme, seqHEntry, seqVEntry)) ||
(scoreGapExtendVertical(scoringScheme, seqHEntry, seqVEntry) !=
scoreGapOpenVertical(scoringScheme, seqHEntry, seqVEntry));
}
// ----------------------------------------------------------------------------
// Function _setUpAndRunAlignment()
// ----------------------------------------------------------------------------
// Scalar implementation.
template <typename TScoreValue, typename TGapSpec, typename TTraceValue, typename TScoreMat, typename TTraceMat,
typename TTraceSegment, typename TSpec,
typename TDPScoutStateSpec,
typename TSequenceH,
typename TSequenceV,
typename TScoreValue2, typename TScoreSpec,
typename TDPType, typename TBand, typename TFreeEndGaps, typename TTraceConfig>
typename Value<Score<TScoreValue2, TScoreSpec> >::Type
_setUpAndRunAlignment(DPContext<DPCell_<TScoreValue, TGapSpec>, TTraceValue, TScoreMat, TTraceMat> & dpContext,
String<TTraceSegment, TSpec> & traceSegments,
DPScoutState_<TDPScoutStateSpec> & dpScoutState,
TSequenceH const & seqH,
TSequenceV const & seqV,
Score<TScoreValue2, TScoreSpec> const & scoringScheme,
AlignConfig2<TDPType, TBand, TFreeEndGaps, TTraceConfig> const & alignConfig)
{
SEQAN_ASSERT_GEQ(length(seqH), 1u);
SEQAN_ASSERT_GEQ(length(seqV), 1u);
typedef typename SetupAlignmentProfile_<TDPType, TFreeEndGaps, TGapSpec, TTraceConfig>::Type TDPProfile;
return _computeAlignment(dpContext, traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig._band,
TDPProfile());
}
template <typename TTraceSegment, typename TSpec,
typename TDPScoutStateSpec,
typename TSequenceH,
typename TSequenceV,
typename TScoreValue2, typename TScoreSpec,
typename TDPType, typename TBand, typename TFreeEndGaps, typename TTraceConfig,
typename TGapModel>
typename Value<Score<TScoreValue2, TScoreSpec> >::Type
_setUpAndRunAlignment(String<TTraceSegment, TSpec> & traceSegments,
DPScoutState_<TDPScoutStateSpec> & dpScoutState,
TSequenceH const & seqH,
TSequenceV const & seqV,
Score<TScoreValue2, TScoreSpec> const & scoringScheme,
AlignConfig2<TDPType, TBand, TFreeEndGaps, TTraceConfig> const & alignConfig,
TGapModel const & /**/)
{
DPContext<DPCell_<TScoreValue2, TGapModel>, typename TraceBitMap_<>::Type> dpContext;
return _setUpAndRunAlignment(dpContext, traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig);
}
template <typename TTraceSegment, typename TSpec, typename TDPScoutStateSpec,
typename TSequenceH, typename TSequenceV, typename TScoreValue2, typename TScoreSpec, typename TDPType,
typename TBand, typename TFreeEndGaps, typename TTraceConfig>
typename Value<Score<TScoreValue2, TScoreSpec> >::Type
_setUpAndRunAlignment(String<TTraceSegment, TSpec> & traceSegments,
DPScoutState_<TDPScoutStateSpec> & dpScoutState,
TSequenceH const & seqH,
TSequenceV const & seqV,
Score<TScoreValue2, TScoreSpec> const & scoringScheme,
AlignConfig2<TDPType, TBand, TFreeEndGaps, TTraceConfig> const & alignConfig)
{
if (_usesAffineGaps(scoringScheme, seqH, seqV))
return _setUpAndRunAlignment(traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig, AffineGaps());
else
return _setUpAndRunAlignment(traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig, LinearGaps());
}
// SIMD aware implementation.
template <typename TScoreValue, typename TGapSpec, typename TTraceValue, typename TScoreMat, typename TTraceMat,
typename TTraceSegment, typename TSpec,
typename TDPScoutStateSpec,
typename TSequenceH,
typename TSequenceV,
typename TScoreValue2, typename TScoreSpec,
typename TDPType, typename TBand, typename TFreeEndGaps, typename TTraceConfig>
typename Value<Score<TScoreValue2, TScoreSpec> >::Type
_setUpAndRunAlignment(DPContext<DPCell_<TScoreValue, TGapSpec>, TTraceValue, TScoreMat, TTraceMat> & dpContext,
StringSet<String<TTraceSegment, TSpec> > & traceSegments,
DPScoutState_<TDPScoutStateSpec> & dpScoutState,
TSequenceH const & seqH,
TSequenceV const & seqV,
Score<TScoreValue2, TScoreSpec> const & scoringScheme,
AlignConfig2<TDPType, TBand, TFreeEndGaps, TTraceConfig> const & alignConfig)
{
SEQAN_ASSERT_GEQ(length(seqH), 1u);
SEQAN_ASSERT_GEQ(length(seqV), 1u);
typedef typename SetupAlignmentProfile_<TDPType, TFreeEndGaps, TGapSpec, TTraceConfig>::Type TDPProfile;
return _computeAlignment(dpContext, traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig._band,
TDPProfile());
}
template <typename TTraceSegment, typename TSpec, typename TDPScoutStateSpec,
typename TSequenceH, typename TSequenceV, typename TScoreValue2, typename TScoreSpec, typename TDPType,
typename TBand, typename TFreeEndGaps, typename TTraceConfig, typename TGapModel>
typename Value<Score<TScoreValue2, TScoreSpec> >::Type
_setUpAndRunAlignment(StringSet<String<TTraceSegment, TSpec> > & traceSegments,
DPScoutState_<TDPScoutStateSpec> & dpScoutState,
TSequenceH const & seqH,
TSequenceV const & seqV,
Score<TScoreValue2, TScoreSpec> const & scoringScheme,
AlignConfig2<TDPType, TBand, TFreeEndGaps, TTraceConfig> const & alignConfig,
TGapModel const & /**/)
{
typedef DPCell_<TScoreValue2, TGapModel> TDPCell;
typedef typename TraceBitMap_<TScoreValue2>::Type TTraceValue;
typedef String<TDPCell, Alloc<OverAligned> > TScoreHost;
typedef String<TTraceValue, Alloc<OverAligned> > TTraceHost;
DPContext<TDPCell, TTraceValue, TScoreHost, TTraceHost> dpContext;
return _setUpAndRunAlignment(dpContext, traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig);
}
template <typename TTrace,
typename TDPScoutStateSpec,
typename TSequenceH,
typename TSequenceV,
typename TScoreValue2, typename TScoreSpec,
typename TDPType, typename TBand, typename TFreeEndGaps, typename TTraceConfig>
typename Value<Score<TScoreValue2, TScoreSpec> >::Type
_setUpAndRunAlignment(TTrace & traceSegments,
DPScoutState_<TDPScoutStateSpec> & dpScoutState,
TSequenceH const & seqH,
TSequenceV const & seqV,
Score<TScoreValue2, TScoreSpec> const & scoringScheme,
AlignConfig2<TDPType, TBand, TFreeEndGaps, TTraceConfig> const & alignConfig)
{
if (_usesAffineGaps(scoringScheme, seqH, seqV))
return _setUpAndRunAlignment(traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig, AffineGaps());
else
return _setUpAndRunAlignment(traceSegments, dpScoutState, seqH, seqV, scoringScheme, alignConfig, LinearGaps());
}
} // namespace seqan
#endif // #ifndef SEQAN_INCLUDE_SEQAN_ALIGN_DP_SETUP_H_
|
