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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: phi_lookup.h,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:04:27  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: phi_lookup.h,v 1000.2 2004/06/01 18:04:27 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 phi_lookup.h
  38.  * Pseudo lookup table structure and database scanning functions used in 
  39.  * PHI-BLAST
  40.  */
  41. #include <algo/blast/core/blast_def.h>
  42. #include <algo/blast/core/blast_options.h>
  43. #include <algo/blast/core/pattern.h>
  44. #include <algo/blast/core/lookup_wrap.h>
  45. #ifndef PHI_LOOKUP__H
  46. #define PHI_LOOKUP__H
  47. #ifdef __cplusplus
  48. extern "C" {
  49. #endif
  50. /*The following 3 flags define 3 options for running the program*/
  51. #define SEED_FLAG 1
  52. #define PATTERN_FLAG 2
  53. #define PAT_SEED_FLAG 3
  54. #define PAT_MATCH_FLAG 4
  55. #define PATTERN_TOO_LONG  2
  56. /** Original allocation size for the starts and lengths arrays for pattern 
  57.  * occurrencies in the query.
  58.  */
  59. #define MIN_PHI_LOOKUP_SIZE 1000
  60. /** Pseudo lookup table structure for PHI-BLAST. Contains starting and ending
  61.  * offsets of pattern occurrences in the query sequence. 
  62.  */
  63. typedef struct PHILookupTable {
  64.    patternSearchItems* pattern_info;
  65.    Boolean is_dna;
  66.    Int4 num_matches;
  67.    Int4 allocated_size;
  68.    Int4* start_offsets;
  69.    Int4* lengths;
  70. } PHILookupTable;
  71. /** Initialize the pseudo lookup table for PHI BLAST */
  72. Int2 PHILookupTableNew(const LookupTableOptions* opt, PHILookupTable* * lut,
  73.                        Boolean is_dna, BlastScoreBlk* sbp);
  74. /* Deallocate memory for the PHI BLAST lookup table */
  75. PHILookupTable* PHILookupTableDestruct(PHILookupTable* lut);
  76. /** Find all occurrencies of a pattern in query, and save starts/stops in the
  77.  * PHILookupTable structure.
  78.  */
  79. Int4 PHIBlastIndexQuery(PHILookupTable* lookup,
  80.         BLAST_SequenceBlk* query, ListNode* location, Boolean is_dna);
  81. /**
  82.  * Scans the subject sequence from "offset" to the end of the sequence.
  83.  * Copies at most array_size hits.
  84.  * Returns the number of hits found.
  85.  * If there isn't enough room to copy all the hits, return early, and update
  86.  * "offset". 
  87.  *
  88.  * @param lookup_wrap contains the pseudo lookup table with offsets of pattern
  89.  *                    occurrencies in query [in]
  90.  * @param query_blk the query sequence [in]
  91.  * @param subject the subject sequence [in]
  92.  * @param offset the offset in the subject at which to begin scanning [in/out]
  93.  * @param query_offsets array to which hits will be copied [out]
  94.  * @param subject_offsets array to which hits will be copied [out]
  95.  * @param array_size length of the offset arrays [in]
  96.  * @return The number of hits found.
  97.  */
  98. Int4 PHIBlastScanSubject(const LookupTableWrap* lookup_wrap,
  99.         const BLAST_SequenceBlk *query_blk, const BLAST_SequenceBlk *subject, 
  100.         Int4* offset, Uint4 * query_offsets, Uint4 * subject_offsets, 
  101.         Int4 array_size);
  102. #ifdef __cplusplus
  103. }
  104. #endif
  105. #endif /* PHI_LOOKUP__H */