gapinfo.h
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:4k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: gapinfo.h,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 18:04:00  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.9
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: gapinfo.h,v 1000.1 2004/06/01 18:04:00 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's offical duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Author: Ilya Dondoshansky
  35.  *
  36.  */
  37. /** @file gapinfo.h
  38.  * Structures definitions from gapxdrop.h in ncbitools 
  39.  * @todo FIXME: doxygen comments
  40.  */
  41. #ifndef __GAPINFO__
  42. #define __GAPINFO__
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. #include <algo/blast/core/blast_def.h>
  47. /** Operation types within the edit script*/
  48. typedef enum EGapAlignOpType { 
  49.    eGapAlignDel = 0, /**< Deletion: a gap in query */
  50.    eGapAlignDel2 = 1,/**< Frame shift deletion of two nucleotides */
  51.    eGapAlignDel1 = 2,/**< Frame shift deletion of one nucleotide */
  52.    eGapAlignSub = 3, /**< Substitution */
  53.    eGapAlignIns1 = 4,/**< Frame shift insertion of one nucleotide */
  54.    eGapAlignIns2 = 5,/**< Frame shift insertion of two nucleotides */
  55.    eGapAlignIns = 6, /**< Insertion: a gap in subject */
  56.    eGapAlignDecline = 7 /**< Non-aligned region */
  57. } EGapAlignOpType;
  58. /** Edit script: linked list of correspondencies between two sequences */
  59. typedef struct GapEditScript {
  60.    EGapAlignOpType op_type;    /**< Type of operation */
  61.    Int4 num;                   /**< Number of operations */
  62.    struct GapEditScript* next; /**< Pointer to next link */
  63. } GapEditScript;
  64. typedef struct GapEditBlock {
  65.     Int4 start1,  start2,       /* starts of alignments. */
  66.         length1, length2,       /* total lengths of the sequences. */
  67.         original_length1, /* Untranslated lengths of the sequences. */
  68.         original_length2;
  69.     Int2 frame1, frame2;     /* frames of the sequences. */
  70.     Boolean translate1, translate2; /* are either of these be translated. */
  71.     Boolean reverse; /* reverse sequence 1 and 2 when producing SeqALign? */
  72.     Boolean is_ooframe; /* Is this out_of_frame edit block? */
  73.     Boolean discontinuous; /* Is this OK to produce discontinuous SeqAlign? */
  74.     GapEditScript* esp;
  75. } GapEditBlock;
  76. /*
  77. Structure to keep memory for state structure.
  78. */
  79. typedef struct GapStateArrayStruct {
  80. Int4  length, /* length of the state_array. */
  81. used; /* how much of length is used. */
  82. Uint1* state_array; /* array to be used. */
  83. struct GapStateArrayStruct* next;
  84. } GapStateArrayStruct;
  85. GapEditScript* 
  86. GapEditScriptNew (GapEditScript* old);
  87. GapEditScript* GapEditScriptDelete (GapEditScript* esp);
  88. GapEditBlock* GapEditBlockNew (Int4 start1, Int4 start2);
  89. GapEditBlock* GapEditBlockDelete (GapEditBlock* edit_block);
  90. GapStateArrayStruct* 
  91. GapStateFree(GapStateArrayStruct* state_struct);
  92. #ifdef __cplusplus
  93. }
  94. #endif
  95. #endif /* !__GAPINFO__ */