Edlib  1.1.2.
Lightweight, super fast C/C++ library for sequence alignment using edit distance.
Public Attributes | List of all members
EdlibAlignResult Struct Reference

#include <edlib.h>

Public Attributes

int editDistance
 
int * endLocations
 
int * startLocations
 
int numLocations
 
unsigned char * alignment
 
int alignmentLength
 
int alphabetLength
 

Detailed Description

Container for results of alignment done by edlibAlign() function.

Member Data Documentation

§ alignment

unsigned char* EdlibAlignResult::alignment

Alignment is found for first pair of start and end locations. Set to NULL if not calculated. Alignment is sequence of numbers: 0, 1, 2, 3. 0 stands for match. 1 stands for insertion to target. 2 stands for insertion to query. 3 stands for mismatch. Alignment aligns query to target from begining of query till end of query. If gaps are not penalized, they are not in alignment. If you do not free whole result object using edlibFreeAlignResult(), do not forget to use free().

§ alignmentLength

int EdlibAlignResult::alignmentLength

Length of alignment.

§ alphabetLength

int EdlibAlignResult::alphabetLength

Number of different characters in query and target together.

§ editDistance

int EdlibAlignResult::editDistance

-1 if k is non-negative and edit distance is larger than k.

§ endLocations

int* EdlibAlignResult::endLocations

Array of zero-based positions in target where optimal alignment paths end. If gap after query is penalized, gap counts as part of query (NW), otherwise not. Set to NULL if edit distance is larger than k. If you do not free whole result object using edlibFreeAlignResult(), do not forget to use free().

§ numLocations

int EdlibAlignResult::numLocations

Number of end (and start) locations.

§ startLocations

int* EdlibAlignResult::startLocations

Array of zero-based positions in target where optimal alignment paths start, they correspond to endLocations. If gap before query is penalized, gap counts as part of query (NW), otherwise not. Set to NULL if not calculated or if edit distance is larger than k. If you do not free whole result object using edlibFreeAlignResult(), do not forget to use free().


The documentation for this struct was generated from the following file: