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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: mm_aligner.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 19:22:14  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.14
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef ALGO___MM_ALIGNER__HPP
  10. #define ALGO___MM_ALIGNER__HPP
  11. /* $Id: mm_aligner.hpp,v 1000.0 2003/10/29 19:22: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:  Yuri Kapustin
  37. *
  38. * File Description:
  39. *   CMMAligner class definition
  40. *
  41. *   CMMAligner encapsulates the Hirschberg's divide-and-conquer
  42. *   algorithm (also credited to Myers and Miller) featuring
  43. *   affine gap penalty model and running in linear space
  44. *
  45. *   E.W. Myers and W. Miller
  46. *   Optimal alignment in linear space
  47. *   Comp. Appl. Biosciences, 4:11-17, 1988 
  48. *
  49. */
  50. #include "nw_aligner.hpp"
  51. #include <list>
  52. #include <corelib/ncbithr.hpp>
  53. /** @addtogroup AlgoAlignMM
  54.  *
  55.  * @{
  56.  */
  57. BEGIN_NCBI_SCOPE
  58. struct SCoordRect; // auxiliary structure, see below
  59. class NCBI_XALGOALIGN_EXPORT CMMAligner: public CNWAligner
  60. {
  61. public:
  62.     CMMAligner();
  63.     CMMAligner(const char* seq1, size_t len1,
  64.                const char* seq2, size_t len2,
  65.                const SNCBIPackedScoreMatrix* scoremat = 0);
  66.     virtual ~CMMAligner() {}
  67.     void    EnableMultipleThreads(bool enable = true);
  68. protected:
  69.     list<ETranscriptSymbol>  m_TransList;
  70.     bool                     m_mt; // multiple threads
  71.     unsigned int             m_maxthreads;
  72.     virtual TScore   x_Run();
  73.     
  74.     void x_DoSubmatrix(const SCoordRect& submatr,
  75.                    list<ETranscriptSymbol>::iterator translist_pos,
  76.                    bool left_top, bool right_bottom);
  77.     void x_RunTop(const SCoordRect& rect,
  78.              vector<TScore>& vE, vector<TScore>& vF, vector<TScore>& vG,
  79.              vector<unsigned char>& trace, bool lt) const;
  80.     void x_RunBtm(const SCoordRect& rect,
  81.              vector<TScore>& vE, vector<TScore>& vF, vector<TScore>& vG,
  82.              vector<unsigned char>& trace, bool rb) const;
  83.     TScore x_RunTerm(const SCoordRect& rect,
  84.                      bool left_top, bool right_bottom,
  85.                      list<ETranscriptSymbol>& subpath);
  86.     
  87.     enum ETransitionType {
  88.         eII = 0,  eDI,   eGI,
  89.         eID,      eDD,   eGD,
  90.         eIG,      eDG,   eGG
  91.     };
  92.     TScore x_FindBestJ( const vector<TScore>& vEtop,
  93.                         const vector<TScore>& vFtop,
  94.                         const vector<TScore>& vGtop,
  95.                         const vector<TScore>& vEbtm,
  96.                         const vector<TScore>& vFbtm,
  97.                         const vector<TScore>& vGbtm,
  98.                         size_t& pos,
  99.                         ETransitionType& trans_type ) const;
  100.     
  101.     size_t x_ExtendSubpath(vector<unsigned char>::const_iterator trace_it,
  102.                            bool direction,
  103.                            list<ETranscriptSymbol>& subpath) const;
  104.     virtual bool x_CheckMemoryLimit();
  105.     friend class CThreadRunOnTop;
  106.     friend class CThreadDoSM;
  107. };
  108. // auxiliary structure
  109.     
  110. struct NCBI_XALGOALIGN_EXPORT SCoordRect {
  111.     size_t i1, j1, i2, j2;
  112.     SCoordRect() {};
  113.     SCoordRect(size_t l, size_t t, size_t r, size_t b):
  114.         i1(l), j1(t), i2(r), j2(b) {}
  115.     unsigned int GetArea() {
  116.         return (i2 - i1 + 1)*(j2 - j1 + 1);
  117.     }
  118. };
  119. END_NCBI_SCOPE
  120. /* @} */
  121. /*
  122.  * ===========================================================================
  123.  * $Log: mm_aligner.hpp,v $
  124.  * Revision 1000.0  2003/10/29 19:22:14  gouriano
  125.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.14
  126.  *
  127.  * Revision 1.14  2003/09/30 19:49:32  kapustin
  128.  * Make use of standard score matrix interface
  129.  *
  130.  * Revision 1.13  2003/09/26 14:43:01  kapustin
  131.  * Remove exception specifications
  132.  *
  133.  * Revision 1.12  2003/09/02 22:29:19  kapustin
  134.  * Add default constructor
  135.  *
  136.  * Revision 1.10  2003/06/17 17:20:28  kapustin
  137.  * CNWAlignerException -> CAlgoAlignException
  138.  *
  139.  * Revision 1.9  2003/04/14 18:56:56  kapustin
  140.  * Run() --> x_Run()
  141.  *
  142.  * Revision 1.8  2003/04/10 19:12:07  kapustin
  143.  * Modify algorithm's description
  144.  *
  145.  * Revision 1.7  2003/04/10 19:04:28  siyan
  146.  * Added doxygen support
  147.  *
  148.  * Revision 1.6  2003/03/18 15:11:22  kapustin
  149.  * Declare virtual memory limit checking function
  150.  *
  151.  * Revision 1.5  2003/02/21 16:41:11  dicuccio
  152.  * Added Win32 export specifier
  153.  *
  154.  * Revision 1.4  2003/01/28 12:34:53  kapustin
  155.  * Move m_score to the base class
  156.  *
  157.  * Revision 1.3  2003/01/22 13:29:11  kapustin
  158.  * CMMAligner: thread classes declared as friends
  159.  *
  160.  * Revision 1.2  2003/01/21 16:36:22  kapustin
  161.  * Support multi-thread interface
  162.  *
  163.  * Revision 1.1  2003/01/21 12:33:10  kapustin
  164.  * Initial revision
  165.  *
  166.  * ===========================================================================
  167.  */
  168. #endif  /* ALGO___MM_ALIGNER__HPP */