开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
struct_dp.h
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：10k
源码类别：

生物技术

开发平台：

C/C++

struct_dp.h：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: struct_dp.h,v $
  4.  * PRODUCTION Revision 1000.0  2004/04/14 20:27:00  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: struct_dp.h,v 1000.0 2004/04/14 20:27:00 gouriano Exp $
  11. * ===========================================================================
  12. *
  13. *                            PUBLIC DOMAIN NOTICE
  14. *               National Center for Biotechnology Information
  15. *
  16. *  This software/database is a "United States Government Work" under the
  17. *  terms of the United States Copyright Act.  It was written as part of
  18. *  the author's official duties as a United States Government employee and
  19. *  thus cannot be copyrighted.  This software/database is freely available
  20. *  to the public for use. The National Library of Medicine and the U.S.
  21. *  Government have not placed any restriction on its use or reproduction.
  22. *
  23. *  Although all reasonable efforts have been taken to ensure the accuracy
  24. *  and reliability of the software and data, the NLM and the U.S.
  25. *  Government do not and cannot warrant the performance or results that
  26. *  may be obtained by using this software or data. The NLM and the U.S.
  27. *  Government disclaim all warranties, express or implied, including
  28. *  warranties of performance, merchantability or fitness for any particular
  29. *  purpose.
  30. *
  31. *  Please cite the author in any work or product based on this material.
  32. *
  33. * ===========================================================================
  34. *
  35. * Authors:  Paul Thiessen
  36. *
  37. * File Description:
  38. *      Dynamic programming-based alignment algorithms (C interface)
  39. *
  40. * ===========================================================================
  41. */
  43. #ifndef STRUCT_DP__H
  44. #define STRUCT_DP__H
  46. #ifdef __cplusplus
  47. extern "C" {
  48. #endif
  50. /* function result codes */
  51. #define STRUCT_DP_FOUND_ALIGNMENT  1  /* found an alignment */
  52. #define STRUCT_DP_NO_ALIGNMENT     2  /* algorithm successful, but no significant alignment found */
  53. #define STRUCT_DP_PARAMETER_ERROR  3  /* error/inconsistency in function parameters */
  54. #define STRUCT_DP_ALGORITHM_ERROR  4  /* error encountered during algorithm execution */
  55. #define STRUCT_DP_OKAY             5  /* generic ok status */
  57. /* lowest possible score */
  58. extern const int DP_NEGATIVE_INFINITY;
  60. /* highest possible loop penalty */
  61. extern const unsigned int DP_POSITIVE_INFINITY;
  63. /*
  64.  * Block alignment structures and functions
  65.  */
  67. /* use for block that is not frozen */
  68. extern const unsigned int DP_UNFROZEN_BLOCK;
  70. /* info on block structure */
  71. typedef struct {
  72.     unsigned int nBlocks;           /* number of blocks */
  73.     unsigned int *blockPositions;   /* first residue of each block on subject (zero-numbered) */
  74.     unsigned int *blockSizes;       /* length of each block */
  75.     unsigned int *maxLoops;         /* nBlocks-1 max loop sizes */
  76.     unsigned int *freezeBlocks;     /* first residue of each block on query (zero-numbered) if frozen;
  77.                                         DP_UNFROZEN_BLOCK otherwise (default); global alignment only! */
  78. } DP_BlockInfo;
  80. /* convenience functions for allocating/destroying BlockInfo structures;
  81.    do not use free (MemFree), because these are C++-allocated! */
  82. extern DP_BlockInfo * DP_CreateBlockInfo(unsigned int nBlocks);
  83. extern void DP_DestroyBlockInfo(DP_BlockInfo *blocks);
  85. /* standard function for calculating max loop length, given a list of the sizes of all the
  86.    corresponding loops in each sequence/row of an existing multiple alignment:
  88.         if percentile < 1.0:
  89.             max = (len such that <percentile>% of loops are <= len) + extension
  90.         else if percentile >= 1.0:
  91.             max = (<percentile> * max loop len)(rounded) + extension
  93.         if cutoff > 0, max will be truncated to be <= cutoff
  94. */
  95. extern unsigned int DP_CalculateMaxLoopLength(
  96.     unsigned int nLoops, const unsigned int *loopLengths,   /* based on existing alignment */
  97.     double percentile, unsigned int extension, unsigned int cutoff);
  99. /* callback function to get the score for a block at a specified position; should
  100.    return DP_NEGATIVE_INFINITY if the block can't be aligned at this position. For
  101.    local alignments, the average expected score for a random match must be <= zero. */
  102. typedef int (*DP_BlockScoreFunction)(unsigned int block, unsigned int queryPos);
  104. /* returned alignment structure */
  105. typedef struct {
  106.     int score;                      /* alignment score */
  107.     unsigned int nBlocks;           /* number of blocks in this alignment */
  108.     unsigned int firstBlock;        /* first block aligned (w.r.t. subject blocks) */
  109.     unsigned int *blockPositions;   /* positions of blocks on query (zero-numbered) */
  110. } DP_AlignmentResult;
  112. /* for destroying alignment result; do not use free (MemFree) */
  113. extern void DP_DestroyAlignmentResult(DP_AlignmentResult *alignment);
  115. /* global alignment routine */
  116. extern int                              /* returns an above STRUCT_DP_ status code */
  117. DP_GlobalBlockAlign(
  118.     const DP_BlockInfo *blocks,         /* blocks on subject */
  119.     DP_BlockScoreFunction BlockScore,   /* scoring function for blocks on query */
  120.     unsigned int queryFrom,             /* range of query to search */
  121.     unsigned int queryTo,
  122.     DP_AlignmentResult **alignment      /* alignment, if one found; caller should destroy */
  123. );
  125. /* local alignment routine */
  126. extern int                              /* returns an above STRUCT_DP_ status code */
  127. DP_LocalBlockAlign(
  128.     const DP_BlockInfo *blocks,         /* blocks on subject; NOTE: block freezing ignored! */
  129.     DP_BlockScoreFunction BlockScore,   /* scoring function for blocks on query */
  130.     unsigned int queryFrom,             /* range of query to search */
  131.     unsigned int queryTo,
  132.     DP_AlignmentResult **alignment      /* alignment, if one found; caller should destroy */
  133. );
  135. /* returned alignment container for multiple tracebacks */
  136. typedef struct {
  137.     unsigned int nAlignments;           /* number of alignments returned */
  138.     DP_AlignmentResult *alignments;     /* individual alignments, highest-scoring first */
  139. } DP_MultipleAlignmentResults;
  141. /* for destroying multiple alignment results; do not use free (MemFree) */
  142. extern void DP_DestroyMultipleAlignmentResults(DP_MultipleAlignmentResults *alignments);
  144. /* local alignment routine returning sorted list of highest-scoring alignments */
  145. extern int                              /* returns an above STRUCT_DP_ status code */
  146. DP_MultipleLocalBlockAlign(
  147.     const DP_BlockInfo *blocks,         /* blocks on subject; NOTE: block freezing ignored! */
  148.     DP_BlockScoreFunction BlockScore,   /* scoring function for blocks on query */
  149.     unsigned int queryFrom,             /* range of query to search */
  150.     unsigned int queryTo,
  151.     DP_MultipleAlignmentResults **alignments,   /* alignments, if any found; caller should destroy */
  152.     unsigned int maxAlignments          /* max # alignments to return, 0 == unlimited (all) */
  153. );
  155. /* callback function to get the score (a positive or zero penalty) for a given loop number and length */
  156. typedef unsigned int (*DP_LoopPenaltyFunction)(unsigned int loopNumber, unsigned int loopLength);
  158. /* global alignment routine for generic loop scoring function */
  159. extern int                              /* returns an above STRUCT_DP_ status code */
  160. DP_GlobalBlockAlignGeneric(
  161.     const DP_BlockInfo *blocks,         /* blocks on subject; note that maxLoops are ignored! */
  162.     DP_BlockScoreFunction BlockScore,   /* scoring function for blocks on query */
  163.     DP_LoopPenaltyFunction LoopScore,   /* loop scoring function */
  164.     unsigned int queryFrom,             /* range of query to search */
  165.     unsigned int queryTo,
  166.     DP_AlignmentResult **alignment      /* alignment, if one found; caller should destroy */
  167. );
  169. /* local alignment routine for generic loop scoring */
  170. extern int                              /* returns an above STRUCT_DP_ status code */
  171. DP_LocalBlockAlignGeneric(
  172.     const DP_BlockInfo *blocks,         /* blocks on subject; NOTE: block freezing ignored! */
  173.     DP_BlockScoreFunction BlockScore,   /* scoring function for blocks on query */
  174.     DP_LoopPenaltyFunction LoopScore,   /* loop scoring function */
  175.     unsigned int queryFrom,             /* range of query to search */
  176.     unsigned int queryTo,
  177.     DP_AlignmentResult **alignment      /* alignment, if one found; caller should destroy */
  178. );
  180. /* local generic alignment routine returning sorted list of highest-scoring alignments */
  181. extern int                              /* returns an above STRUCT_DP_ status code */
  182. DP_MultipleLocalBlockAlignGeneric(
  183.     const DP_BlockInfo *blocks,         /* blocks on subject; NOTE: block freezing ignored! */
  184.     DP_BlockScoreFunction BlockScore,   /* scoring function for blocks on query */
  185.     DP_LoopPenaltyFunction LoopScore,   /* loop scoring function */
  186.     unsigned int queryFrom,             /* range of query to search */
  187.     unsigned int queryTo,
  188.     DP_MultipleAlignmentResults **alignments,   /* alignments, if any found; caller should destroy */
  189.     unsigned int maxAlignments          /* max # alignments to return, 0 == unlimited (all) */
  190. );
  192. #ifdef __cplusplus
  193. }
  194. #endif
  196. #endif /* STRUCT_DP__H */
  198. /*
  199. * ---------------------------------------------------------------------------
  200. * $Log: struct_dp.h,v $
  201. * Revision 1000.0  2004/04/14 20:27:00  gouriano
  202. * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
  203. *
  204. * Revision 1.1  2004/02/19 01:46:04  thiessen
  205. * move to include/algo/structure/struct_dp
  206. *
  207. * Revision 1.12  2003/12/19 14:37:50  thiessen
  208. * add local generic loop function alignment routines
  209. *
  210. * Revision 1.11  2003/12/08 16:33:59  thiessen
  211. * fix signed/unsigned mix
  212. *
  213. * Revision 1.10  2003/12/08 16:21:36  thiessen
  214. * add generic loop scoring function interface
  215. *
  216. * Revision 1.9  2003/09/07 00:06:19  thiessen
  217. * add multiple tracebacks for local alignments
  218. *
  219. * Revision 1.8  2003/08/22 14:28:49  thiessen
  220. * add standard loop calculating function
  221. *
  222. * Revision 1.7  2003/07/11 15:27:48  thiessen
  223. * add DP_ prefix to globals
  224. *
  225. * Revision 1.6  2003/06/22 12:11:37  thiessen
  226. * add local alignment
  227. *
  228. * Revision 1.5  2003/06/19 13:48:23  thiessen
  229. * cosmetic/typo fixes
  230. *
  231. * Revision 1.4  2003/06/18 21:46:09  thiessen
  232. * add traceback, alignment return structure
  233. *
  234. * Revision 1.3  2003/06/18 19:17:17  thiessen
  235. * try once more to fix lf issue
  236. *
  237. * Revision 1.2  2003/06/18 19:10:17  thiessen
  238. * fix lf issues
  239. *
  240. * Revision 1.1  2003/06/18 16:54:12  thiessen
  241. * initial checkin; working global block aligner and demo app
  242. *
  243. */