summaryrefslogtreecommitdiff
path: root/mmdb2/mmdb_math_align.h
blob: fca7bc6a6d68fc494fc96720cd09a61b8a102dc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
//  $Id: mmdb_math_align.h $
//  =================================================================
//
//   CCP4 Coordinate Library: support of coordinate-related
//   functionality in protein crystallography applications.
//
//   Copyright (C) Eugene Krissinel 2000-2013.
//
//    This library is free software: you can redistribute it and/or
//    modify it under the terms of the GNU Lesser General Public
//    License version 3, modified in accordance with the provisions
//    of the license to address the requirements of UK law.
//
//    You should have received a copy of the modified GNU Lesser
//    General Public License along with this library. If not, copies
//    may be downloaded from http://www.ccp4.ac.uk/ccp4license.php
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU Lesser General Public License for more details.
//
//  =================================================================
//
//    12.09.13   <--  Date of Last Modification.
//                   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//  -----------------------------------------------------------------
//
//  **** Module  :     Align <interface>
//       ~~~~~~~~~
//  **** Classes    :  mmdb::math::Alignment  (char strings alignment)
//       ~~~~~~~~~~~~  mmdb::math::Alignment1 (int  vectors alignment)
//
//  (C) E.Krissinel  2000-2013
//
//  =================================================================
//

#ifndef __MMDB_MATH_Align__
#define __MMDB_MATH_Align__

#include "mmdb_io_stream.h"

namespace mmdb  {

  namespace math  {

    //  =====================   AlignParams   ======================

    DefineClass(AlignParams);
    DefineStreamFunctions(AlignParams);

    class AlignParams : public io::Stream  {

      public :

        realtype  gapWeight,spaceWeight;
        realtype  equalScore,nequalScore;
        int       method;

        AlignParams();
        AlignParams ( io::RPStream Object );

        void write ( io::RFile f );
        void read  ( io::RFile f );

      protected :
        void InitAlignParams();

    };


    //  ======================   Alignment   =======================

    DefineClass(Alignment);

    enum ALIGN_METHOD  {
      ALIGN_GLOBAL   = 0,
      ALIGN_LOCAL    = 1,
      ALIGN_GLOBLOC  = 2,
      ALIGN_FREEENDS = 3
    };

    class  Alignment : public io::Stream  {

      public :

        Alignment  ();
        Alignment  ( io::RPStream Object );
        ~Alignment ();

        void SetAffineModel ( realtype WGap,   realtype WSpace  );
        void SetScores      ( realtype SEqual, realtype SNEqual );

        void Align          ( cpstr S, cpstr T,
                              ALIGN_METHOD Method=ALIGN_GLOBAL );

        inline pstr     GetAlignedS()  {  return AlgnS;      }
        inline pstr     GetAlignedT()  {  return AlgnT;      }
        inline realtype GetScore   ()  {  return VAchieved;  }
        inline char     GetSpace   ()  {  return Space;      }

        realtype GetSimilarity(); // Score-weighted sequence id
        realtype GetSeqId     (); // Primitive sequence id

        virtual void OutputResults ( io::RFile f, cpstr S, cpstr T  );

        void read  ( io::RFile f );
        void write ( io::RFile f );

      protected :

        char     Space;
        int      AlignKey, SLen,TLen;
        rmatrix  VT,ET,FT;
        pstr     AlgnS,AlgnT;
        realtype VAchieved;
        realtype SEq,SNEq, Wg,Ws;

        virtual void  InitAlignment();
        virtual void  FreeMemory   ();
        virtual realtype  Score    ( char A, char B );

        void    BuildGATable ( cpstr S, cpstr T,
                               bool FreeSEnd, bool FreeTEnd );
        void    BuildLATable ( cpstr S, cpstr T );
        void    Backtrace    ( cpstr S, cpstr T, int J, int I,
                               bool StopAtZero );
        void    AdjustEnds   ( cpstr S, cpstr T, int J, int I );
        void    PrintVT      ( cpstr S, cpstr T );

    };



    //  ======================   Alignment1   =======================

    DefineClass(Alignment1);

    class  Alignment1 : public io::Stream  {

      public :

        Alignment1 ();
        Alignment1 ( io::RPStream Object );
        ~Alignment1();

        void SetAffineModel ( realtype WGap,   realtype WSpace  );
        void SetScores      ( realtype SEqual, realtype SNEqual );

        void Align          ( ivector S, int SLength,
                              ivector T, int TLength,
                              ALIGN_METHOD Method=ALIGN_GLOBAL );

        inline ivector  GetAlignedS   ()  { return AlgnS;     }
        inline ivector  GetAlignedT   ()  { return AlgnT;     }
        inline int      GetAlignLength()  { return AlgnLen;   }
        inline realtype GetScore      ()  { return VAchieved; }

        realtype GetSimilarity(); // Score-weighted sequence id

        virtual void OutputResults ( io::RFile f, ivector S, int lenS,
                                                  ivector T, int lenT );

        void read  ( io::RFile f );
        void write ( io::RFile f );

      protected :

        int      Space;
        int      AlignKey, SLen,TLen, AlgnLen;
        rmatrix  VT,ET,FT;
        ivector  AlgnS,AlgnT;
        realtype VAchieved;
        realtype SEq,SNEq, Wg,Ws;

        virtual void  InitAlignment1();
        virtual void  FreeMemory    ();
        virtual realtype  Score     ( int A, int B );

        void    BuildGATable ( ivector S, ivector T,
                               bool FreeSEnds, bool FreeTEnds );
        void    BuildLATable ( ivector S, ivector T );
        void    Backtrace    ( ivector S, ivector T, int J, int I,
                               bool StopAtZero );
        void    AdjustEnds   ( ivector S, ivector T, int J, int I );
        void    PrintVT      ( ivector S, ivector T );

    };

  }  // namespace math

}  // namespace mmdb

#endif