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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: blast_def.h,v $
  4.  * PRODUCTION Revision 1000.4  2004/06/01 18:03:18  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.42
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: blast_def.h,v 1000.4 2004/06/01 18:03:18 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 blast_def.h
  38.  * Definitions of major structures used throughout BLAST
  39.  */
  40. #ifndef __BLAST_DEF__
  41. #define __BLAST_DEF__
  42. #include <algo/blast/core/ncbi_std.h>
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  46. /* Belongs to a higher level header */
  47. #ifndef sfree
  48. #define sfree(x) __sfree((void**)&(x))
  49. #endif
  50. void __sfree(void** x); /* implemented in lib/util.c */
  51. /******************** Preprocessor definitions ******************************/
  52. /** Program type */
  53. #define blast_type_blastn 0
  54. #define blast_type_blastp 1
  55. #define blast_type_blastx 2
  56. #define blast_type_tblastn 3
  57. #define blast_type_tblastx 4
  58. #define blast_type_rpsblast 5
  59. #define blast_type_rpstblastn 6
  60. #define blast_type_undefined 255
  61. /** Codons are always of length 3 */
  62. #ifndef CODON_LENGTH
  63. #define CODON_LENGTH 3
  64. #endif
  65. /** Compression ratio of nucleotide bases (4 bases in 1 byte) */
  66. #ifndef COMPRESSION_RATIO
  67. #define COMPRESSION_RATIO 4
  68. #endif
  69. /** Number of frames to which we translate in translating searches */
  70. #ifndef NUM_FRAMES
  71. #define NUM_FRAMES 6
  72. #endif
  73. #ifndef NUM_STRANDS
  74. #define NUM_STRANDS 2
  75. #endif
  76. /********************* Structure definitions ********************************/
  77. /** Structure for keeping the query masking information */
  78. typedef struct BlastMaskLoc {
  79.    Int4 index; /**< Index of the query sequence this mask is applied to */
  80.    ListNode* loc_list; /**< List of mask locations */
  81.    struct BlastMaskLoc* next; /**< Pointer to the next query mask */
  82. } BlastMaskLoc;
  83. /** Structure to hold a sequence. */
  84. typedef struct BLAST_SequenceBlk {
  85.    Uint1* sequence; /**< Sequence used for search (could be translation). */
  86.    Uint1* sequence_start; /**< Start of sequence, usually one byte before 
  87.                                sequence as that byte is a NULL sentinel byte.*/
  88.    Int4     length;         /**< Length of sequence. */
  89.    Int4 context; /**< Context of the query, needed for multi-query searches */
  90.    Int2 frame; /**< Frame of the query, needed for translated searches */
  91.    Int4 oid; /**< The ordinal id of the current sequence */
  92.    Boolean sequence_allocated; /**< TRUE if memory has been allocated for 
  93.                                   sequence */
  94.    Boolean sequence_start_allocated; /**< TRUE if memory has been allocated 
  95.                                         for sequence_start */
  96.    Uint1* oof_sequence; /**< Mixed-frame protein representation of a
  97.                              nucleotide sequence for out-of-frame alignment */
  98.    Boolean oof_sequence_allocated; /**< TRUE if memory has been allocated 
  99.                                         for oof_sequence */
  100.    BlastMaskLoc* lcase_mask; /**< Locations to be masked from operations on 
  101.                                 this sequence: lookup table for query; 
  102.                                 scanning for subject. */
  103.    Boolean lcase_mask_allocated; /**< TRUE if memory has been allocated for 
  104.                                     lcase_mask */
  105. } BLAST_SequenceBlk;
  106. /** The query related information 
  107.  */
  108. typedef struct BlastQueryInfo {
  109.    Int4 first_context; /**< Index of the first element of the context array */
  110.    Int4 last_context;  /**< Index of the last element of the context array */
  111.    int num_queries;   /**< Number of query sequences */
  112.    Int4* context_offsets; /**< Offsets of the individual queries in the
  113.                                concatenated super-query */
  114.    Int4* length_adjustments; /**< Length adjustments for boundary conditions */
  115.    Int8* eff_searchsp_array; /**< Array of effective search spaces for
  116.                                   multiple queries. Dimension = number of 
  117.                                   query sequences. */
  118.    Uint4 max_length; /**< Length of the longest among the concatenated 
  119.                         queries */
  120. } BlastQueryInfo;
  121. /** A structure containing two integers, used e.g. for locations for the 
  122.  * lookup table.
  123.  */
  124. typedef struct SSeqRange {
  125.    Int4 left;
  126.    Int4 right;
  127. } SSeqRange;
  128. /** BlastSeqLoc is a ListNode with choice equal to the sequence local id,
  129.  * and data->ptrvalue pointing to a SSeqRange structure defining the 
  130.  * location interval in the sequence.
  131.  */
  132. #define BlastSeqLoc ListNode
  133. #ifdef __cplusplus
  134. }
  135. #endif
  136. #endif /* !__BLAST_DEF__ */