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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: lookup_wrap.h,v $
  4.  * PRODUCTION Revision 1000.2  2004/06/01 18:04:14  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /* $Id: lookup_wrap.h,v 1000.2 2004/06/01 18:04:14 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 lookup_wrap.h
  38.  * Wrapper for all lookup tables used in BLAST
  39.  */
  40. #ifndef __LOOKUP_WRAP__
  41. #define __LOOKUP_WRAP__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #include <algo/blast/core/blast_def.h>
  46. #include <algo/blast/core/blast_options.h>
  47. #include <algo/blast/core/blast_rps.h>
  48. #include <algo/blast/core/blast_stat.h>
  49. /** Wrapper structure for different types of BLAST lookup tables */
  50. typedef struct LookupTableWrap {
  51.    Uint1 lut_type; /**< What kind of a lookup table it is? */
  52.    void* lut; /**< Pointer to the actual lookup table structure */
  53. } LookupTableWrap;
  54. /** Create the lookup table for all query words.
  55.  * @param query The query sequence [in]
  56.  * @param lookup_options What kind of lookup table to build? [in]
  57.  * @param lookup_segments Locations on query to be used for lookup table
  58.  *                        construction [in]
  59.  * @param sbp Scoring block containing matrix [in]
  60.  * @param lookup_wrap_ptr The initialized lookup table [out]
  61.  * @param rps_info Structure containing RPS blast setup information [in]
  62.  */
  63. Int2 LookupTableWrapInit(BLAST_SequenceBlk* query, 
  64.         const LookupTableOptions* lookup_options,
  65.         ListNode* lookup_segments, BlastScoreBlk* sbp, 
  66.         LookupTableWrap** lookup_wrap_ptr, RPSInfo *rps_info);
  67. /** Deallocate memory for the lookup table */
  68. LookupTableWrap* LookupTableWrapFree(LookupTableWrap* lookup);
  69. #define OFFSET_ARRAY_SIZE 4096
  70. /** Determine the size of the offsets arrays to be filled by
  71.  * the ScanSubject function.
  72.  */
  73. Int4 GetOffsetArraySize(LookupTableWrap* lookup);
  74. #ifdef __cplusplus
  75. }
  76. #endif
  77. #endif /* !__LOOKUP_WRAP__ */