dynprog.cpp 13.5 KB
Newer Older
Mikaël Salson's avatar
Mikaël Salson committed
1
/*
2 3 4 5 6 7 8
  This file is part of Vidjil <http://www.vidjil.org>
  Copyright (C) 2011, 2012, 2013, 2014, 2015 by Bonsai bioinformatics 
  at CRIStAL (UMR CNRS 9189, Université Lille) and Inria Lille
  Contributors: 
      Mathieu Giraud <mathieu.giraud@vidjil.org>
      Mikaël Salson <mikael.salson@vidjil.org>
      Marc Duez <marc.duez@vidjil.org>
Mikaël Salson's avatar
Mikaël Salson committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

  "Vidjil" is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  "Vidjil" 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with "Vidjil". If not, see <http://www.gnu.org/licenses/>
*/

#include "dynprog.h"
#include "tools.h"
26
#include "segment.h"
Mikaël Salson's avatar
Mikaël Salson committed
27 28 29 30 31
#include <cassert>
#include <list>
#include <cstdlib>
#include <string>

32 33 34 35 36 37 38 39
#define SUBST '|'
#define MISMATCH '.'
#define INSER 'i'
#define DELET 'd'
#define HOMO2X 'h'
#define HOMO2Y 'h'
#define FIN ' '
#define BEGIN 'B'
Mikaël Salson's avatar
Mikaël Salson committed
40
#define BACKSIZE 120
Mikaël Salson's avatar
Mikaël Salson committed
41 42 43 44 45 46 47 48 49 50 51 52

using namespace std;


Cost::Cost(int match, int mismatch, int indel, int del_end, int homopolymer)
{
  this -> match = match ;
  this -> mismatch = mismatch ;
  this -> insertion = indel ;
  this -> deletion = indel ;
  this -> deletion_end = del_end ;
  this -> homopolymer = (homopolymer == MINUS_INF ? indel: homopolymer);
53

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
  this -> open_insertion = this -> open_deletion = MINUS_INF ;
  this -> extend_insertion = this -> extend_deletion = MINUS_INF ;
  this -> affine_gap = false ;
}

Cost::Cost(int match, int mismatch, int open_gap, int extend_gap, int del_end, int homopolymer)
{
  this -> match = match ;
  this -> mismatch = mismatch ;
  this -> insertion = MINUS_INF ;
  this -> deletion = MINUS_INF ;
  this -> deletion_end = del_end ;
  this -> homopolymer = homopolymer ;

  this -> open_insertion = this -> open_deletion = open_gap ;
  this -> extend_insertion = this -> extend_deletion = extend_gap ;
70
  this -> affine_gap = true ;
Mikaël Salson's avatar
Mikaël Salson committed
71 72 73 74 75 76 77 78 79
}


ostream& operator<<(ostream& out, const Cost& cost)
{
  out << "(" << cost.match 
      << ", " << cost.mismatch
      << "/" << cost.insertion
      << "/" << cost.deletion
80 81
      << ", " << cost.open_insertion << cost.extend_insertion
      << "/" << cost.open_deletion << cost.extend_deletion
Mikaël Salson's avatar
Mikaël Salson committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
      << ", " << cost.deletion_end
      << ", " << cost.homopolymer
      << ")" ;
  return out;
}

Cost::Cost()
{
}

int Cost::substitution(char a, char b)
{
  return (a == b) ? match : mismatch ;
}

int Cost::homo2(char xa, char xb, char y)
{
  return ((xa == xb) && (xb == y)) ? homopolymer : MINUS_INF ;
}

102 103 104
double Cost::toPValue(int score)
{
  // TODO: compute an actual p-value
105
  return (score <= MIN_MATCHES * match) ? BAD_EVALUE : 1 / (double) score ;
106 107
}

Mikaël Salson's avatar
Mikaël Salson committed
108 109 110 111 112 113 114 115 116 117 118 119 120

DynProg::DynProg(const string &x, const string &y, DynProgMode mode, const Cost& cost, const bool reverse_x, const bool reverse_y)
{
  this -> x = reverse_x ? reverse(x) : x ;
  this -> y = reverse_y ? reverse(y) : y ;

  this -> reverse_x = reverse_x ;
  this -> reverse_y = reverse_y ;

  m = x.size();
  n = y.size();
  // cout << "Dynprog " << x << "(" << m << ") / " << y << "(" << n << ")" << endl ;

121
  B = new operation*[m+1];
Mikaël Salson's avatar
Mikaël Salson committed
122
  for (int i = 0; i <= m; i++) {
123
    B[i] = new operation[n+1];
Mikaël Salson's avatar
Mikaël Salson committed
124
  }
125 126 127 128 129 130 131 132
  Bins = new operation*[m+1];
  for (int i = 0; i <= m; i++) {
    Bins[i] = new operation[n+1];
  }
  Bdel = new operation*[m+1];
  for (int i = 0; i <= m; i++) {
    Bdel[i] = new operation[n+1];
  }  
Mikaël Salson's avatar
Mikaël Salson committed
133 134 135 136 137 138 139
  this -> mode = mode;
  this -> cost = cost;

  this -> best_i = -1 ;
  this -> best_j = -1 ;
  this -> first_i = -1 ;
  this -> first_j = -1 ;
Mikaël Salson's avatar
Mikaël Salson committed
140 141 142 143
  
  gap1=NULL;
  gap2=NULL;
  linkgap=NULL;
Mikaël Salson's avatar
Mikaël Salson committed
144 145 146 147 148

  init();
}

DynProg::~DynProg() {
149

Mikaël Salson's avatar
Mikaël Salson committed
150 151
  for (int i = 0; i <= m; i++) {
    delete [] B[i];
152 153
    delete [] Bins[i];
    delete [] Bdel[i];
Mikaël Salson's avatar
Mikaël Salson committed
154
  }
155
  delete [] B;  
156 157
  delete [] Bins;
  delete [] Bdel;  
Mikaël Salson's avatar
Mikaël Salson committed
158 159 160
  delete [] gap1;
  delete [] gap2;
  delete [] linkgap;
Mikaël Salson's avatar
Mikaël Salson committed
161 162 163
}

void DynProg::init()
164 165 166 167 168 169
{
  for (int i=1; i<=m; i++)
    {
      B[i][0].type = INSER ;
      B[i][0].i = i-1 ;
      B[i][0].j = 0 ;
170
      Bdel[i][0].score = Bins[i][0].score = MINUS_INF ;
171 172 173 174 175 176 177
    }

  for (int j=1; j<=n; j++)
    {
      B[0][j].type = DELET ;    
      B[0][j].i = 0 ;
      B[0][j].j = j-1 ;
178
      Bdel[0][j].score = Bins[0][j].score = MINUS_INF ;
179 180
    }

Mikaël Salson's avatar
Mikaël Salson committed
181 182
  if (mode == Local || mode == LocalEndWithSomeDeletions)
    for (int i=0; i<=m; i++)
183
      B[i][0].score = 0 ;
Mathieu Giraud's avatar
Mathieu Giraud committed
184 185
  else if (mode == GlobalButMostlyLocal)
    for (int i=0; i<=m; i++)
186
      B[i][0].score = i * cost.insertion / 2 ;
Mathieu Giraud's avatar
Mathieu Giraud committed
187 188
  else // Global, SemiGlobal
    for (int i=0; i<=m; i++)
189
      B[i][0].score = i * cost.insertion ;
Mikaël Salson's avatar
Mikaël Salson committed
190 191 192
   
  if (mode == SemiGlobal || mode == SemiGlobalTrans || mode == Local || mode == LocalEndWithSomeDeletions)
    for (int j=0; j<=n; j++)
193
      B[0][j].score = 0 ;
Mathieu Giraud's avatar
Mathieu Giraud committed
194 195
  else if (mode == GlobalButMostlyLocal)
    for (int j=0; j<=n; j++)
196
      B[0][j].score = j * cost.deletion / 2 ;
Mathieu Giraud's avatar
Mathieu Giraud committed
197
  else // Global
Mikaël Salson's avatar
Mikaël Salson committed
198
    for (int j=0; j<=n; j++)
199
      B[0][j].score = j * cost.deletion ;
Mikaël Salson's avatar
Mikaël Salson committed
200 201
}

202 203 204 205 206 207 208 209 210 211 212
inline void try_operation(operation &best, int type, int i, int j, int score)
{
  if (score > best.score)
    {
      best.type = type ;
      best.i = i ;
      best.j = j ;
      best.score = score ;
    }
}

Mikaël Salson's avatar
Mikaël Salson committed
213 214 215
int DynProg::compute()
{
  best_score = MINUS_INF ;
216 217 218 219
  best_i = 0 ;
  best_j = 0 ;
  
  operation best ;
Mikaël Salson's avatar
Mikaël Salson committed
220 221 222 223

  for (int i=1; i<=m; i++)
    for (int j=1; j<=n; j++)
    {
224
      best.score = MINUS_INF ;
Mikaël Salson's avatar
Mikaël Salson committed
225

226
      // The edit operations, with their backtracking information and their score
227 228

      // Match, mismatch
229
      try_operation(best, SUBST, i-1, j-1, B[i-1][j-1].score + cost.substitution(x[i-1], y[j-1]));
230

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
      if (!cost.affine_gap)
        {
          // Regular indels
          try_operation(best, INSER, i-1, j  , B[i-1][j  ].score + cost.insertion);
          try_operation(best, DELET, i  , j-1, B[i  ][j-1].score + cost.deletion);
        }
      else
        {
          // Gotoh affine gaps - insertion
          Bins[i][j].score = MINUS_INF ;
          try_operation(Bins[i][j], 'o', i-1, j, B[i-1][j].score + cost.open_insertion);
          try_operation(Bins[i][j], 'x', Bins[i-1][j].i, j, Bins[i-1][j].score + cost.extend_insertion);
          try_operation(best, INSER, Bins[i][j].i, j ,Bins[i][j].score);

          // Gotoh affine gaps - deletions
          Bdel[i][j].score = MINUS_INF ;
          try_operation(Bdel[i][j], 'o', i, j-1, B[i][j-1].score + cost.open_deletion);
          try_operation(Bdel[i][j], 'x', i, Bdel[i][j-1].j, Bdel[i-1][j].score + cost.extend_deletion);
          try_operation(best, DELET, i, Bdel[i][j].j,  Bdel[i][j].score);
        }

      // Homopolymers
253 254
      try_operation(best, HOMO2X, i-2, j-1, i > 1 ? B[i-2][j-1].score + cost.homo2(x[i-2], x[i-1], y[j-1]) : MINUS_INF);
      try_operation(best, HOMO2Y, i-1, j-2, j > 1 ? B[i-1][j-2].score + cost.homo2(y[j-2], y[j-1], x[i-1]) : MINUS_INF);
255
      
256
      // Local alignment
257 258
      if (mode == Local || mode == LocalEndWithSomeDeletions)
	try_operation(best, BEGIN, 0, 0, 0);
Mikaël Salson's avatar
Mikaël Salson committed
259

260 261
      if ((best.type == SUBST) && (x[i-1] != y[j-1]))
        best.type = MISMATCH ;
Mikaël Salson's avatar
Mikaël Salson committed
262

263 264
      // Fill the score and the backtrack information
      B[i][j] = best ;
Mikaël Salson's avatar
Mikaël Salson committed
265
      
266 267
      // cout << " " << i << "," << j << " " << best_op.type << " " <<  best_op.i << "," << best_op.j << " "  << best_op.score << " " << best << endl ;

Mikaël Salson's avatar
Mikaël Salson committed
268 269
      if (mode == Local || mode == LocalEndWithSomeDeletions)
	{
270
	  int tbest = best.score ;
Mikaël Salson's avatar
Mikaël Salson committed
271 272 273 274 275 276 277 278 279 280 281

	  if (mode == LocalEndWithSomeDeletions)
	    tbest += cost.deletion_end*(n-j);   
     
	  if (tbest > best_score)
	    {
	      best_score = tbest ;
	      best_i = i ;
	      best_j = j ;
	    }
	    
282
	  if (best.score == 0){
283
	    B[i][j].type = FIN;
Mikaël Salson's avatar
Mikaël Salson committed
284 285
	  }
	}
Mikaël Salson's avatar
Mikaël Salson committed
286

Mikaël Salson's avatar
Mikaël Salson committed
287 288
      if (mode == Local || mode == LocalEndWithSomeDeletions)
	{
289
      	  if (best.score == 0){
290
	    B[i][j].type = FIN;
Mikaël Salson's avatar
Mikaël Salson committed
291 292 293 294 295
	  }
	}
      
    }

296 297
  // End. Find best_i and best_j, put FIN keywords where the backtrack should stop
  
Mikaël Salson's avatar
Mikaël Salson committed
298 299
  if (mode == Local || mode == LocalEndWithSomeDeletions)
    {
300 301
      for (int j=0; j<=n; j++){
	B[0][j].type = FIN;
Mikaël Salson's avatar
Mikaël Salson committed
302 303
      }
      for (int i=0; i<=m; i++){
304
	B[i][0].type = FIN;
Mikaël Salson's avatar
Mikaël Salson committed
305 306 307 308 309 310 311 312
      }
      
    }
  if (mode == SemiGlobal)
    {
      best_i = m ;
      
      for (int j=1; j<=n; j++)
313
	if (B[m][j].score > best_score)
Mikaël Salson's avatar
Mikaël Salson committed
314
	  {
315
	    best_score = B[m][j].score ;
Mikaël Salson's avatar
Mikaël Salson committed
316 317 318
	    best_j = j ;
	  }
      for (int i=0; i<=m; i++){
319
	B[i][0].type = FIN;
Mikaël Salson's avatar
Mikaël Salson committed
320 321 322 323 324 325 326 327
      }
    }

  if (mode == SemiGlobalTrans)
    {
      best_j = n ;
      
      for (int i=1; i<=m; i++)
328
	if (B[i][n].score > best_score)
Mikaël Salson's avatar
Mikaël Salson committed
329
	  {
330
	    best_score = B[i][n].score ;
Mikaël Salson's avatar
Mikaël Salson committed
331 332 333 334
	    best_i = i ;
	  }
	  
      for (int i=0; i<=n; i++){
335
	B[0][i].type = FIN;
336
      }     
Mikaël Salson's avatar
Mikaël Salson committed
337 338
    }

Mathieu Giraud's avatar
Mathieu Giraud committed
339
  if ((mode == Global) || (mode == GlobalButMostlyLocal))
Mikaël Salson's avatar
Mikaël Salson committed
340 341 342
    {
      best_i = m ;
      best_j = n ;
343
      best_score = B[m][n].score;
Mikaël Salson's avatar
Mikaël Salson committed
344 345 346 347 348 349 350 351
    }

  if (reverse_x)
    best_i = m - best_i + 1 ;

  if (reverse_y)
    best_j = n - best_j + 1;

352 353
  B[0][0].type = FIN;
  
Mikaël Salson's avatar
Mikaël Salson committed
354 355 356 357 358 359 360 361 362
  // In the matrix positions start at 1, but start positions may start at 0
  best_i -= 1;   
  best_j -= 1;

  return best_score ;
}

void DynProg::backtrack()
{
363
  // Tables for displaying the alignment
Mikaël Salson's avatar
Mikaël Salson committed
364 365 366 367
  gap1 = new int[x.size()+1];
  linkgap = new int[x.size()+1];
  gap2 = new int[y.size()+1];
      
368
  for (unsigned int i = 0; i <=x.size(); i++) {
Mikaël Salson's avatar
Mikaël Salson committed
369 370 371
    gap1[i] = 0;
    linkgap[i] = 0;
  }
372
  for (unsigned int i = 0; i <= y.size(); i++) {
Mikaël Salson's avatar
Mikaël Salson committed
373 374 375 376 377 378 379
    gap2[i] = 0;
  }
  
  
  int g1=x.size();
  int g2=y.size();
  
380 381
  int i=best_i+1;
  int j=best_j+1;
382

383
  // Compute backtrack strings
Mikaël Salson's avatar
Mikaël Salson committed
384
  
385 386
  ostringstream back_x;
  ostringstream back_y;
Mikaël Salson's avatar
Mikaël Salson committed
387 388
  ostringstream back_tr;
  
389 390 391 392 393 394
  while (1) {

    if ((i<0) || (j<0))
      { 
        cout << "Invalid backtrack: " << i << "," << j << endl ;
        exit(1);
Mikaël Salson's avatar
Mikaël Salson committed
395
      }
396 397 398

    if  (B[i][j].type == FIN)
      break ;
Mikaël Salson's avatar
Mikaël Salson committed
399
      
400
    // cout << "bt " << i << "/" << j << " " << B[i][j].type << " " << B[i][j].i << "," << B[i][j].j << endl ;
401 402 403
    
    int next_i = B[i][j].i;
    int next_j = B[i][j].j;
Mikaël Salson's avatar
Mikaël Salson committed
404

405 406
    // The maximum number of characters implied by this operation
    int max_k = max(i - next_i, j - next_j);
Mikaël Salson's avatar
Mikaël Salson committed
407
      
408 409 410
    for (int k=0; k<max_k; k++)
      {
        linkgap[g1]=g2;
411 412 413

        // Some character(s) from x, then fill with spaces
        if (i-k > next_i)
414
          {
415
            back_x << x[i-1-k];
416 417 418 419
            g1--;
          }
        else
          {
420
            back_x << " " ;
421 422
            gap1[g1]++ ;
          }
423 424 425

        // Some character(s) from y, then fill with spaces
        if (j-k > next_j)
426
          {
427
            back_y << y[j-1-k];
428 429 430 431
            g2--;
          }
        else
          {
432
            back_y << " " ;
433 434
            gap2[g2]++ ;
          }
435 436 437 438 439 440

        // The operation character, then fill with spaces
        if (k == max_k-1)          
          back_tr << B[i][j].type ;
        else
          back_tr << " " ;
441
      }
Mikaël Salson's avatar
Mikaël Salson committed
442
    
443 444
    i = next_i;
    j = next_j;
Mikaël Salson's avatar
Mikaël Salson committed
445 446
  }

447 448 449
  // Format backtrack strings
  
  string str1, str2, str3;
450
  str1 = back_x.str();
Mikaël Salson's avatar
Mikaël Salson committed
451 452 453 454
  str1 =string (str1.rbegin(), str1.rend());
  str1 = str1;
  str2=back_tr.str();
  str2 = string (str2.rbegin(), str2.rend());
455
  str3 = back_y.str();
Mikaël Salson's avatar
Mikaël Salson committed
456
  str3 = string (str3.rbegin(), str3.rend());
457 458

  ostringstream back;    
459 460 461
  back << setw(3) << i   << " " << str1.substr(0, BACKSIZE-8) << endl;
  back << setw(3) << " " << " " << str2.substr(0, BACKSIZE-8) << endl;
  back << setw(3) << j   << " " << str3.substr(0, BACKSIZE-8) << endl << endl;
Mikaël Salson's avatar
Mikaël Salson committed
462 463 464 465 466
  for (size_t k=0 ; (BACKSIZE-8+k*BACKSIZE)< str1.length() ; k++){
    back << str1.substr(BACKSIZE-8+k*BACKSIZE, BACKSIZE) << endl;
    back << str2.substr(BACKSIZE-8+k*BACKSIZE, BACKSIZE) << endl;
    back << str3.substr(BACKSIZE-8+k*BACKSIZE, BACKSIZE) << endl << endl;
  }
467
  back << "score: " << best_score << endl;
Mikaël Salson's avatar
Mikaël Salson committed
468
  
469 470
  first_i=i;
  first_j=j;
Mikaël Salson's avatar
Mikaël Salson committed
471 472
  
  str_back=back.str();
Mathieu Giraud's avatar
Mathieu Giraud committed
473 474

  // cout << str_back << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
}


float identity_percent(int score)
{
  int match = (score + IdentityDirty.match/2) / IdentityDirty.match ;

  int mismatch = (score - match * IdentityDirty.match) / IdentityDirty.mismatch ;

  float pcent = (100. * (float) match) / (match + mismatch) ;

  // cout << score << "  " << match << "  " << mismatch << "  " << pcent << endl ; 

  return pcent ;
}


ostream& operator<<(ostream& out, const DynProg& dp)
{
  out << "       " ;

  for (int j=0; j<dp.n; j++)
    out << setw(4) << dp.y[j] << " ";

  out << endl ;

  for (int i=0; i<=dp.m; i++)
    {
      if (i)
	out << dp.x[i-1] << " " ;
      else
	out << "  " ;

      for (int j=0; j<=dp.n; j++)
509
        {
510 511
          if (dp.B[i][j].score)
            out << setw(4) << dp.B[i][j].score << dp.B[i][j].type ;
512 513 514
          else
            out << "    " << dp.B[i][j].type ;
        }
Mikaël Salson's avatar
Mikaël Salson committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
      out << endl ;      
    }
  
  out << "best: " << dp.best_i << "," << dp.best_j << endl;

  return out ;
}


Cost strToCost(string str, Cost default_cost){

  if (str.length()!=0){
    string::size_type stTemp = str.find(',');
	  
    std::list<int> val;
    
    while(stTemp != string::npos)
    {
	  val.push_back(atoi(str.substr(0, stTemp).c_str() ) );
	  str = str.substr(stTemp + 1);
	  stTemp = str.find(',');
    }
    val.push_back(atoi(str.c_str() ) );

    if (val.size()==5){ 
      int val1=val.front();
      val.pop_front();
      int val2=val.front();
      val.pop_front();
      int val3=val.front();
      val.pop_front();
      int val4=val.front();
      val.pop_front();
      int val5=val.front();
      val.pop_front();
      Cost result = Cost(val1, val2, val3, val4, val5);
      cout << "use custom Cost "<< result << endl;
      return result;
    }
    
    cout << "incorrect Cost format, use default "<< default_cost<<endl;
  }
  
  return default_cost;
}