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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: matrix_freq_ratios.h,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 18:08:14  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO_BLAST_CORE___MATRIX_FREQ_RATIOS__H
  10. #define ALGO_BLAST_CORE___MATRIX_FREQ_RATIOS__H
  11. /*  $Id: matrix_freq_ratios.h,v 1000.1 2004/06/01 18:08:14 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Author:  Christiam Camacho
  37.  *
  38.  */
  39. /** @file matrix_freq_ratios.h
  40.  *  Interface to retrieve the frequency ratios for various scoring matrices.
  41.  *
  42.  *  See explanation in p 2996 of Nucleic Acids Research, 2001, Vol 29, No 14.
  43.  */
  44. #include <algo/blast/core/blast_encoding.h>
  45. #ifdef __cplusplus
  46. extern "C" {
  47. #endif
  48. /** Stores the frequency ratios along with their bit scale factor */
  49. typedef struct SFreqRatios {
  50.     /** The actual frequency ratios */
  51.     double**   data;
  52.     /** Used to multiply the values in the above matrix to obtain scores in bit
  53.      * units */
  54.     int        bit_scale_factor;
  55. } SFreqRatios;
  56. /** Retrive the matrix's frequency ratios.
  57.  * @param matrix_name Available options include:
  58.  *          BLOSUM62
  59.  *          BLOSUM62_20
  60.  *          BLOSUM62_20A
  61.  *          BLOSUM62_20B
  62.  *          BLOSUM45
  63.  *          BLOSUM80
  64.  *          BLOSUM50
  65.  *          BLOSUM90
  66.  *          PAM30
  67.  *          PAM70
  68.  *          PAM250
  69.  * @return NULL on error
  70.  */
  71. SFreqRatios*
  72. _PSIMatrixFrequencyRatiosNew(const char* matrix_name);
  73. /** Deallocate the frequency ratios structure */
  74. SFreqRatios*
  75. _PSIMatrixFrequencyRatiosFree(SFreqRatios* freq_ratios);
  76. #ifdef __cplusplus
  77. }
  78. #endif
  79. /*
  80.  * ===========================================================================
  81.  *
  82.  * $Log: matrix_freq_ratios.h,v $
  83.  * Revision 1000.1  2004/06/01 18:08:14  gouriano
  84.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
  85.  *
  86.  * Revision 1.2  2004/05/06 15:28:11  camacho
  87.  * Provide an interface to retrive the matrices' frequency ratios
  88.  *
  89.  *
  90.  * ===========================================================================
  91.  */
  92. #endif /* !ALGO_BLAST_CORE__MATRIX_FREQ_RATIOS__H */