File: dp_context.h

package info (click to toggle)
seqan2 2.3.1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 222,320 kB
  • ctags: 40,872
  • sloc: cpp: 252,894; ansic: 86,805; python: 6,534; sh: 985; xml: 570; makefile: 236; awk: 51
file content (187 lines) | stat: -rw-r--r-- 7,478 bytes parent folder | download | duplicates (2)
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
// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2016, 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>
// ==========================================================================
// Implements the context that can be passed to the dp functions in order
// to reuse memory blocks in mutliple calls of the same function.
// ==========================================================================

#ifndef INCLUDE_SEQAN_ALIGN_DP_CONTEXT_H_
#define INCLUDE_SEQAN_ALIGN_DP_CONTEXT_H_

namespace seqan
{

// ============================================================================
// Forwards
// ============================================================================

template <typename T>
struct GetDPScoreMatrix
{};

template <typename T>
struct GetDPTraceMatrix
{};

// ============================================================================
// Tags, Classes, Enums
// ============================================================================

template <typename TScoreValue, typename TGapCosts>
struct DPContext
{
    typedef typename GetDPScoreMatrix<DPContext>::Type TScoreMatrixHost;
    typedef typename GetDPTraceMatrix<DPContext>::Type TTraceMatrixHost;

    TScoreMatrixHost _scoreMatrix;
    TTraceMatrixHost _traceMatrix;

    DPContext() : _scoreMatrix(), _traceMatrix()
    {}
};

// ============================================================================
// Metafunctions
// ============================================================================

// ----------------------------------------------------------------------------
// Metafunction GetDPScoreMatrix
// ----------------------------------------------------------------------------

template <typename TScoreValue, typename TGapCosts>
struct GetDPScoreMatrix<DPContext<TScoreValue, TGapCosts> >
{
    typedef DPCell_<TScoreValue, TGapCosts> TDPScoreValue_;
    typedef DPMatrix_<TDPScoreValue_, FullDPMatrix> TDPScoreMatrix_;

    typedef typename Host<TDPScoreMatrix_>::Type Type;
};

template <typename TScoreValue, typename TGapCosts>
struct GetDPScoreMatrix<DPContext<TScoreValue, TGapCosts> const >
{
    typedef DPCell_<TScoreValue, TGapCosts> TDPScoreValue_;
    typedef DPMatrix_<TDPScoreValue_, FullDPMatrix> TDPScoreMatrix_;

    typedef typename Host<TDPScoreMatrix_>::Type const Type;
};

// ----------------------------------------------------------------------------
// Metafunction GetDPTraceMatrix
// ----------------------------------------------------------------------------

template <typename TScoreValue, typename TGapCosts>
struct GetDPTraceMatrix<DPContext<TScoreValue, TGapCosts> >
{
    typedef typename TraceBitMap_<TScoreValue>::Type TTraceValue_;
    typedef DPMatrix_<TTraceValue_, FullDPMatrix> TDPScoreMatrix_;

    typedef typename Host<TDPScoreMatrix_>::Type Type;
};

template <typename TScoreValue, typename TGapCosts>
struct GetDPTraceMatrix<DPContext<TScoreValue, TGapCosts> const >
{
    typedef typename TraceBitMap_<TScoreValue>::Type TTraceValue_;
    typedef DPMatrix_<TTraceValue_, FullDPMatrix> TDPScoreMatrix_;

    typedef typename Host<TDPScoreMatrix_>::Type const Type;
};

// ============================================================================
// Functions
// ============================================================================

// ----------------------------------------------------------------------------
// Function dpScoreMatrix()
// ----------------------------------------------------------------------------

template <typename TScoreValue, typename TGapCosts>
inline typename GetDPScoreMatrix<DPContext<TScoreValue, TGapCosts> >::Type &
getDpScoreMatrix(DPContext<TScoreValue, TGapCosts> & dpContext)
{
    return dpContext._scoreMatrix;
}

template <typename TScoreValue, typename TGapCosts>
inline typename GetDPScoreMatrix<DPContext<TScoreValue, TGapCosts> const >::Type &
getDpScoreMatrix(DPContext<TScoreValue, TGapCosts> const & dpContext)
{
    return dpContext._scoreMatrix;
}

// ----------------------------------------------------------------------------
// Function dpTraceMatrix()
// ----------------------------------------------------------------------------

template <typename TScoreValue, typename TGapCosts>
inline typename GetDPTraceMatrix<DPContext<TScoreValue, TGapCosts> >::Type &
getDpTraceMatrix(DPContext<TScoreValue, TGapCosts> & dpContext)
{
    return dpContext._traceMatrix;
}

template <typename TScoreValue, typename TGapCosts>
inline typename GetDPTraceMatrix<DPContext<TScoreValue, TGapCosts> const >::Type &
getDpTraceMatrix(DPContext<TScoreValue, TGapCosts> const & dpContext)
{
    return dpContext._traceMatrix;
}

// ----------------------------------------------------------------------------
// Function setDpScoreMatrix()
// ----------------------------------------------------------------------------

template <typename TScoreValue, typename TGapCosts>
inline void
setDpTraceMatrix(DPContext<TScoreValue, TGapCosts> & dpContext,
                typename GetDPScoreMatrix<DPContext<TScoreValue, TGapCosts> >::Type const & scoreMatrix)
{
    dpContext._scoreMatrix = scoreMatrix;
}

// ----------------------------------------------------------------------------
// Function setDpTraceMatrix()
// ----------------------------------------------------------------------------

template <typename TScoreValue, typename TGapCosts>
inline void
setDpTraceMatrix(DPContext<TScoreValue, TGapCosts> & dpContext,
                typename GetDPTraceMatrix<DPContext<TScoreValue, TGapCosts> >::Type const & traceMatrix)
{
    dpContext._tarceMatrix = traceMatrix;
}

}

#endif // INCLUDE_SEQAN_ALIGN_DP_CONTEXT_H_