SW#
All Files Functions Variables Typedefs Macros
alignment.h
Go to the documentation of this file.
1 /*
2 swsharp - CUDA parallelized Smith Waterman with applying Hirschberg's and
3 Ukkonen's algorithm and dynamic cell pruning.
4 Copyright (C) 2013 Matija Korpar, contributor Mile Šikić
5 
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10 
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 
19 Contact the author by mkorpar@gmail.com.
20 */
27 #ifndef __SW_SHARP_ALIGNMENTH__
28 #define __SW_SHARP_ALIGNMENTH__
29 
30 #include "chain.h"
31 #include "scorer.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
43 #define MOVE_STOP 0
44 
50 #define MOVE_LEFT 2
51 
57 #define MOVE_UP 3
58 
65 #define MOVE_DIAG 1
66 
79 typedef struct Alignment Alignment;
80 
102 extern Alignment* alignmentCreate(Chain* query, int queryStart, int queryEnd,
103  Chain* target, int targetStart, int targetEnd, int score, Scorer* scorer,
104  char* path, int pathLen);
105 
111 extern void alignmentDelete(Alignment* alignment);
112 
124 extern char alignmentGetMove(Alignment* alignment, int index);
125 
133 extern int alignmentGetPathLen(Alignment* alignment);
134 
142 extern Chain* alignmentGetQuery(Alignment* alignment);
143 
151 extern int alignmentGetQueryEnd(Alignment* alignment);
152 
160 extern int alignmentGetQueryStart(Alignment* alignment);
161 
169 extern int alignmentGetScore(Alignment* alignment);
170 
178 extern Scorer* alignmentGetScorer(Alignment* alignment);
179 
187 extern Chain* alignmentGetTarget(Alignment* alignment);
188 
196 extern int alignmentGetTargetEnd(Alignment* alignment);
197 
205 extern int alignmentGetTargetStart(Alignment* alignment);
206 
216 extern void alignmentCopyPath(Alignment* alignment, char* dest);
217 
227 extern Alignment* alignmentDeserialize(char* bytes);
228 
238 extern void alignmentSerialize(char** bytes, int* bytesLen, Alignment* alignment);
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 #endif // __SW_SHARP_ALIGNMENTH__
Alignment * alignmentCreate(Chain *query, int queryStart, int queryEnd, Chain *target, int targetStart, int targetEnd, int score, Scorer *scorer, char *path, int pathLen)
Alignment object constructor.
Alignment * alignmentDeserialize(char *bytes)
Alignment deserialization method.
int alignmentGetTargetStart(Alignment *alignment)
Target start getter.
int alignmentGetScore(Alignment *alignment)
Score getter.
Provides object used for alignment scoring.
void alignmentSerialize(char **bytes, int *bytesLen, Alignment *alignment)
Alignment serialization method.
Chain * alignmentGetQuery(Alignment *alignment)
Query getter.
Chain * alignmentGetTarget(Alignment *alignment)
Target getter.
struct Scorer Scorer
Scorer object used for alignment scoring.
Definition: scorer.h:42
struct Alignment Alignment
Pairwise sequnce alignment result storage object.
Definition: alignment.h:79
int alignmentGetPathLen(Alignment *alignment)
Path len getter.
Provides object for storing named sequnces.
int alignmentGetQueryStart(Alignment *alignment)
Query start getter.
void alignmentCopyPath(Alignment *alignment, char *dest)
Copies path to the destination buffer.
Scorer * alignmentGetScorer(Alignment *alignment)
Scorer getter.
char alignmentGetMove(Alignment *alignment, int index)
Move getter.
int alignmentGetTargetEnd(Alignment *alignment)
Target end getter.
int alignmentGetQueryEnd(Alignment *alignment)
Query end getter.
struct Chain Chain
Chain object used for storing named sequnces.
Definition: chain.h:43
void alignmentDelete(Alignment *alignment)
Alignment destructor.